Links

Links allow you to create workspace-specific relationships between any two objects in DevRev. This feature enables you to define meaningful connections with custom names that reflect your business processes.

This section provides an overview of links and walks you through the process of creating and managing them. By the end of this section, you'll be able to:

1. Define link types
2. Create links between objects
3. List link types
4. Update link types
5. Deprecate link types

Concepts

Link type

A link type defines a relationship between two types of objects. It specifies:

• The source object types that the link initiates from
• The target object types that the link can be created to
• A forward name describing the relationship from source to target
• A backward name describing the relationship from target to source

The example below shows a ticket that is dependent on an issue. The backward name for the relationship "is dependency of" is shown in the reverse direction.

Supported object types

Links can be created between the following object types:

• custom object
• work (issue, ticket, task, opportunity)
• account, user
• part (product, capability, feature, enhancement)

For more details on customization or custom object concepts, please refer to the documentation below:

• Customization
• Custom objects

Default link types

Every DevRev workspace is automatically provisioned with a set of default link types. These define the standard relationships between built-in object types, such as parent-child, related, dependency, and more. The default link types specify the allowed source and target object types, forward and backward names, and constraints for each relationship.

They are automatically created when a workspace is provisioned, and cannot be modified.

To retrieve the default link types for your workspace, use the list endpoint:

curl --location 'https://api.devrev.ai/link-types.custom.list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{}'

Default link types are identified by is_default set to true in the response:

{
    "custom_link_types": [
        {
            "id": "don:core:dvrv-us-1:devo/demo:custom_link_type/default-1",
            "name": "Parent Child",
            "forward_name": "Parent",
            "backward_name": "Child",
            "source_types": [{ "leaf_type": "ticket" }],
            "target_types": [{ "leaf_type": "ticket" }],
            "is_default": true
        }
    ]
}

Create link types

To create this relationship, make an API call to create a link type:

curl --location 'https://api.devrev.ai/link-types.custom.create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "name": "Link between ticket and campaign",
    "source_types": [
        {
            "leaf_type": "ticket"
        }
    ],
    "target_types": [
        {
            "leaf_type": "campaign",
            "is_custom_leaf_type": true
        }
    ],
    "forward_name": "is parent of",
    "backward_name": "is child of"
}'

The link type above defines:

• A descriptive name
• Source types that the link can be created from (ticket)
• Target types that the link can be created to (campaign custom object)
• Forward name ("is parent of") describing the relationship from ticket to campaign
• Backward name ("is child of") describing the relationship from campaign to ticket

Create links between objects

Once you have a link type (either a default or one you've created), you can create links between objects:

curl --location 'https://api.devrev.ai/links.create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "custom_link_type": "don:core:dvrv-us-1:devo/demo:custom_link_type/1",
    "source": "don:core:dvrv-us-1:devo/demo:ticket/1",
    "target": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1"
}'

Bidirectional link creation

When creating a link, you don't need to worry about which object to specify as the source and which as the target. The API automatically normalizes the direction to match the link type definition.

For example, if you create a "related to" link from a conversation to a ticket, the system resolves this against the corresponding default link type definition and creates the link from ticket to conversation. The link is still bidirectional—it can be traversed in both directions using the forward and backward names—but the stored state always adheres to the link type definition.

List link types

You can list link types in your workspace, with optional filtering:

curl --location 'https://api.devrev.ai/link-types.custom.list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "source_types_v2": [
        {
            "leaf_type": "ticket"
        }
    ]
}'

Update link types

You can update the existing link type to include additional source types:

curl --location 'https://api.devrev.ai/link-types.custom.update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "id": "don:core:dvrv-us-1:devo/demo:custom_link_type/1",
    "name": "Link type between issue/ticket and campaign",
    "source_types_v2": [
        {
            "leaf_type": "issue"
        },
        {
            "leaf_type": "ticket"
        }
    ]
}'

Restrict links by subtype

You can restrict which objects are allowed in a link by using the subtype and leaf_only fields in the source or target type descriptors:

curl --location 'https://api.devrev.ai/link-types.custom.create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "name": "Link between social media issues and tickets",
    "source_types": [
        {
            "leaf_type": "issue",
            "subtype": "social_media"
        }
    ],
    "target_types": [
        {
            "leaf_type": "ticket"
        }
    ],
    "forward_name": "is related to",
    "backward_name": "is related to"
}'

This configuration:

• Allows issues of subtype "social_media" to be linked to tickets
• Rejects attempts to link issues with no subtype or with other subtypes

Deprecate link types

To deprecate a link type, use the update endpoint and set is_deprecated to true:

curl --location 'https://api.devrev.ai/link-types.custom.update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
    "id": "don:core:dvrv-us-1:devo/demo:custom_link_type/1",
    "is_deprecated": true
}'

Default links from tickets and issues

Default links from tickets

Default links from issues

Behavior and constraints by link type