integrations

POST /api/v1/integrations/add-zendesk/

Create a new Zendesk integration

Request

Request body

pkinteger
urlstring
namestring required

Your preferred name for this integration.

modulestring

The provider of the integration.

contact_groupsstring[]

Array of contact names or IDs this integration is assigned to

is_erroredboolean
last_errorstring
api_emailstring

Email of the Zendesk agent whose API token is being used.

api_tokenstring

API token created for the agent in the Zendesk Admin Center.

zendesk_subdomainstring uri

The base URL of your Zendesk account, e.g. "https://your-company.zendesk.com"

priority'' | 'low' | 'normal' | 'high' | 'urgent'

Priority to assign to tickets created by this integration.

ticket_type'' | 'problem' | 'incident' | 'question' | 'task'

Type to assign to tickets created by this integration.

tagsstring

A comma separated list of tags to attach to each ticket created. Check tags are appended automatically.

autoresolveboolean

Automatically mark the ticket as solved once the check is back up.

Response

pkinteger
urlstring
namestring required

Your preferred name for this integration.

modulestring

The provider of the integration.

contact_groupsstring[]

Array of contact names or IDs this integration is assigned to

is_erroredboolean
last_errorstring
api_emailstring

Email of the Zendesk agent whose API token is being used.

api_tokenstring

API token created for the agent in the Zendesk Admin Center.

zendesk_subdomainstring uri

The base URL of your Zendesk account, e.g. "https://your-company.zendesk.com"

priority'' | 'low' | 'normal' | 'high' | 'urgent'

Priority to assign to tickets created by this integration.

ticket_type'' | 'problem' | 'incident' | 'question' | 'task'

Type to assign to tickets created by this integration.

tagsstring

A comma separated list of tags to attach to each ticket created. Check tags are appended automatically.

autoresolveboolean

Automatically mark the ticket as solved once the check is back up.

Changes

No recorded changes to this operation across all 1 revision of this API.