Skip to content

Commit 8b7ea13

Browse files
committed
Get rid of "custom", just "links"
1 parent f7597ad commit 8b7ea13

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

fern/docs/pages/custom-links.mdx

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
1-
Custom links allow you to create organization-specific relationships between any two objects in DevRev.
1+
Links allow you to create organization-specific relationships between any two objects in DevRev.
22
This feature enables you to define meaningful connections with custom names that reflect your business processes.
33

4-
This section provides an overview of custom links and walks you through the process of creating and managing them.
4+
This section provides an overview of links and walks you through the process of creating and managing them.
55
By the end of this section, you'll be able to:
6-
1. Define custom link types
6+
1. Define link types
77
2. Create links between objects
8-
3. List custom link types
9-
4. Update custom link types
10-
5. Deprecate custom link types
8+
3. List link types
9+
4. Update link types
10+
5. Deprecate link types
1111

1212
## Concepts
1313

14-
### Custom link type
14+
### Link type
1515

16-
A custom link type defines a relationship between two types of objects. It specifies:
16+
A link type defines a relationship between two types of objects. It specifies:
1717
- The source object types that the link initiates from
1818
- The target object types that the link can be created to
1919
- A forward name describing the relationship from source to target
2020
- A backward name describing the relationship from target to source
2121

2222
### Supported object types
2323

24-
Custom links can be created between the following object types:
24+
Links can be created between the following object types:
2525
- custom object
2626
- issue, ticket, task, opportunity
2727
- account, user
2828
- part (product, capability, feature, enhancement)
2929

3030
For more details on customization or custom object concepts, please refer to the documentation below:
3131
- [Customization](./object-customization)
32-
- [Custom objects](./custom-objects)
32+
- [Custom objects](./custom-objects)
3333

34-
## Create custom link types
34+
## Create link types
3535

3636
<Callout intent="note">
3737
Let's say you want to establish a parent-child relationship between tickets and a custom object
3838
type called "Campaign". This relationship helps track which tickets are assigned to which campaigns.
3939
</Callout>
4040

41-
To create this relationship, make an API call to create a custom link type:
41+
To create this relationship, make an API call to create a link type:
4242

4343
```curl
4444
curl --location 'https://api.devrev.ai/link-types.custom.create' \
@@ -63,7 +63,7 @@ curl --location 'https://api.devrev.ai/link-types.custom.create' \
6363
}'
6464
```
6565

66-
The custom link type above defines:
66+
The link type above defines:
6767
- A descriptive name
6868
- Source types that the link can be created from (ticket)
6969
- Target types that the link can be created to (campaign custom object)
@@ -72,7 +72,7 @@ The custom link type above defines:
7272

7373
## Create links between objects
7474

75-
Once you have defined a custom link type, you can create links between objects:
75+
Once you have defined a link type, you can create links between objects:
7676

7777
```curl
7878
curl --location 'https://api.devrev.ai/links.create' \
@@ -87,15 +87,15 @@ curl --location 'https://api.devrev.ai/links.create' \
8787
```
8888

8989
<Callout intent="tip">
90-
When creating a custom link:
90+
When creating a link:
9191
- Set `link_type` to `"custom_link"`
92-
- Provide the custom link type ID in `custom_link_type`
92+
- Provide the link type ID in `custom_link_type`
9393
- Ensure both source and target objects exist to prevent dangling links
9494
</Callout>
9595

96-
## List custom link types
96+
## List link types
9797

98-
You can list custom link types in your organization, with optional filtering:
98+
You can list link types in your organization, with optional filtering:
9999

100100
```curl
101101
curl --location 'https://api.devrev.ai/link-types.custom.list' \
@@ -111,14 +111,14 @@ curl --location 'https://api.devrev.ai/link-types.custom.list' \
111111
}'
112112
```
113113

114-
## Update custom link types
114+
## Update link types
115115

116116
<Callout intent="note">
117117
Now, you want to expand the source types to allow both issues and tickets to have this relationship
118118
with campaigns.
119119
</Callout>
120120

121-
You can update the existing custom link type to include additional source types:
121+
You can update the existing link type to include additional source types:
122122

123123
```curl
124124
curl --location 'https://api.devrev.ai/link-types.custom.update' \
@@ -145,7 +145,7 @@ You may want to restrict links to specific subtypes of objects. For example, onl
145145
of a particular subtype to be linked to tickets.
146146
</Callout>
147147

148-
Create a custom link type with subtype restrictions:
148+
Create a link type with subtype restrictions:
149149

150150
```curl {11}
151151
curl --location 'https://api.devrev.ai/link-types.custom.create' \
@@ -178,14 +178,14 @@ This configuration:
178178
To add more valid source subtypes, use the update endpoint to add them to the `source_types` array.
179179
</Callout>
180180

181-
## Deprecate custom link types
181+
## Deprecate link types
182182

183183
<Callout intent="note">
184-
Custom link types cannot be deleted, only deprecated. This ensures that existing links maintain
184+
Link types cannot be deleted, only deprecated. This ensures that existing links maintain
185185
referential integrity and prevents data corruption.
186186
</Callout>
187187

188-
To deprecate a custom link type, use the update endpoint and set `deprecated` to `true`:
188+
To deprecate a link type, use the update endpoint and set `deprecated` to `true`:
189189
```curl {6}
190190
curl --location 'https://api.devrev.ai/link-types.custom.update' \
191191
--header 'Content-Type: application/json' \

0 commit comments

Comments
 (0)