POST
/
v1
/
link
curl --request POST \
  --url http://localhost:8000/api/v1/link \
  --header 'Content-Type: application/json' \
  --data '{
  "category": [
    {}
  ],
  "integrationDefinitionId": "<string>",
  "expiresIn": 123,
  "linkName": "<string>",
  "workspaceId": "0a58f56e-3f59-4f4e-a8e1-a9e47aae5c3c"
}'
{
  "linkId": "<string>",
  "linkName": "<string>",
  "canExpire": true,
  "preferOAuth": true,
  "expiresIn": 123,
  "category": [
    {}
  ],
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "IntegrationAccount": [
    {
      "integrationAccountId": "<string>",
      "integrationDefinitionId": "<string>",
      "integrationConfiguration": {},
      "authType": "<string>",
      "workspaceId": "<string>",
      "integrationAccountName": "<string>",
      "deleted": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "linkId": "<string>"
    }
  ]
}

Body

application/json
category
object[]
required

Integration categories you want this link to support. Example: Ticketing, Documentation etc

integrationDefinitionId
string

Integration definition Id when you want to restrict the link to specific integration

expiresIn
number
required

Link expires after the specified seconds

linkName
string
required

Name of the link. Majorly used to easily search for this in UI Example: You can use customer name: Poozle

workspaceId
string
required

Unique identifier used to identify all the other resources. You can find this in the UI after the host and /workspaces/{workspaceId}

Response

201 - application/json
linkId
string
required

A unique identifier for Link

linkName
string
required

Name of the link. Majorly used to easily search for this in UI Example: You can use customer name: Poozle

canExpire
boolean
required

Boolean to tell if the link can expire

preferOAuth
boolean
required

Boolean to tell if only OAuth should be accepted as authentication process

expiresIn
number
required

If canExpire is set to true. This indicates seconds in which the link will expire.

category
object[]
required

Category integration belongs to Example: Ticketing, Documentation etc

workspaceId
string
required

Unique identifier for Workspace.

createdAt
string
required

When the Link was created.

updatedAt
string
required

When the Link was updated last.

IntegrationAccount
object[]

Integration Accounts