POST
/
v1
/
integration_definition
curl --request POST \
  --url http://localhost:8000/api/v1/integration_definition \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "sourceUrl": "<string>",
  "integrationType": {},
  "workspaceId": "0a58f56e-3f59-4f4e-a8e1-a9e47aae5c3c"
}'
{
  "integrationDefinitionId": "<string>",
  "name": "<string>",
  "key": "<string>",
  "icon": "<string>",
  "version": "<string>",
  "releaseStage": {},
  "sourceUrl": "<string>",
  "integrationType": {},
  "workspaceId": "<string>",
  "deleted": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
name
string
required

Name of the integration

sourceUrl
string
required

This is the URL where the compiled source code of integration

integrationType
object
required

Category integration belongs to Example: Ticketing, Documentation etc

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
integrationDefinitionId
string
required

A unique identifier for Integration Definition

name
string
required

Name of the integration

key
string
required

A unique identifier in text used to identify Integration

icon
string | null
required

Icon for the integration

version
string
required

Current version of the integration

releaseStage
object
required

This tells the status of the integration. If Alpha most features will be working but can expect some issues.

sourceUrl
string
required

This is the URL where the compiled source code of integration

integrationType
object
required

Category integration belongs to Example: Ticketing, Documentation etc

workspaceId
string | null
required

A unique identifier for Workspace

deleted
string | null
required

When this account is deleted. If deleted

createdAt
string
required

When the integration account was created.

updatedAt
string
required

When the integration account was updated last.