v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Integrations

Update integration

Updates an integration. <br> <br> Permissions required: Permission to update the integration:

the user has read-only administrative right.
the user is the admin of the team that the integration belongs to.

patch/api/{cloudId}/v1/integrations/{id}

Path parameters

idstring required

Request body

namestring

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

enabledboolean

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

descriptionstring

Description of the integration.

teamIdstring

ID of the team that integration belongs to.

typeSpecificPropertiesobject

This is for some integration spesific properties. For instance this map is consisting suppressNotifications for incoming integrations, emailUsername for email integrations or allowReadAccess/allowWriteAccess/allowDeleteAccessallowConfigurationAccess for API Integrations.

Example request

{
  "name": "Webhook Integration A",
  "enabled": true,
  "description": "A Sample of Webhook Integration",
  "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9",
  "typeSpecificProperties": {
    "addAlertDetails": false,
    "headers": {},
    "addAlertDescription": false,
    "outgoingSettingsEnabled": false,
    "forwardingActionGroupEnabled": true,
    "url": "http://asd.com"
  }
}

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.