v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Integrations

Create integration

Creates an integration. It can be team or global integration by using teamId in the payload.

Permissions required: Permission to create an integration:

the user has edit configuration right.
the user is the admin of the team that the integration belongs to.

<br>Slack and Microsoft Teams types of integration are not supported for this operation.

post/api/{cloudId}/v1/integrations

Request body

namestring required

Name of the integration. Name must be unique for each integration.

typestring required

Type of the integration. (For instance, "API" for API Integration.

descriptionstring

Description of the integration.

enabledboolean

This parameter is for specifying whether the integration will be enabled or not. Defaults to false

teamIdstring

ID of the team that integration belongs to.

typeSpecificPropertiesobject

Integration spesific properties may be provided to this object. For instance, this map may constist

suppressNotifications for incoming integrations
emailUsername for email integrations
allowReadAccess , allowWriteAccess, allowDeleteAccess, allowConfigurationAccess for API Integrations
some credential properties or tool spesific properties such as URLs for outgoing integrations

Example request

{
  "name": "Email Integration A",
  "type": "Email",
  "description": "A Sample of Email Integration",
  "enabled": true,
  "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9",
  "typeSpecificProperties": {
    "emailUsername": "email-integration-test1",
    "suppressNotifications": false
  }
}

Response

Returned if the request is successful.

idstring

ID of the integration.

typestring

Type of the integration.

namestring

Name of the integration.

enabledboolean

Indicates whether the integration is enabled or not.

teamIdstring

ID of the team that integration belongs to.

typeSpecificPropertiesobject

Integration specific properties.