Integrate with Zendesk

What does the integration offer?

Compass provides a powerful bidirectional integration with Zendesk. When a new ticket is created in Zendesk, a corresponding alert is automatically created in Compass, containing rich information about the ticket. Compass provides rich notifications with on-call rotation, scheduling, and alert escalations to ensure the best ticket management. As you execute actions on the alerts, such as acknowledge, comment, or close, the Zendesk ticket is also automatically updated with comments about these alert actions.

How does the integration work?

When a ticket is created in Zendesk, it creates an alert in Compass.
When a ticket is solved or closed in Zendesk, it closes the alert in Compass.
When a comment is added to the ticket in Zendesk, it adds a note to the alert in Compass.
If Send Alert Updates Back to Zendesk is enabled, actions for Zendesk are executed in Zendesk when the chosen action is executed in Compass for alerts that are created by the Zendesk integration.
If Create Zendesk Tickets for Compass Alerts is enabled, actions for Zendesk are executed in Zendesk when the chosen action is executed in Compass for alerts that have a source other than the Zendesk integration.

The action mapping feature is explained in detail in the Map alert actions section on this page.

Add a Zendesk Integration

To add a Zendesk integration in Compass, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Zendesk”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the integration URL generated for your account (that contains the endpoint URL and API key).
You will use this URL and key while configuring the integration in Zendesk later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Configure the integration in Zendesk

To configure the integration in Zendesk, complete the following steps:

In Zendesk, go to the Admin page.
Select Apps and Integrations > Webhooks.
Select Create Webhook.
Select Trigger or automation.
Paste the URL copied previously into Endpoint URL.
Select POST for Request method.
Select Create Webhook.
From the admin panel, select Object and rules > Triggers.
Select Add Trigger.
Create the triggers as needed. Find out how to set triggers.

Map alert actions

In Compass, you can define mappings between Compass actions and Zendesk actions. The following values must be set up to configure actions:

API Token: The API token created in your Zendesk account
Subdomain: The subdomain of the Zendesk account (e.g. 'atlas7486' for http://atlas7486.zendesk.com )
Email: The email used to log into your Zendesk account

For alerts created by Zendesk

Use this section to map Compass actions to Zendesk actions when the source of the alert is Zendesk (that is when the alert is created by the Zendesk integration).
Map Compass actions to Zendesk actions. For example, add an internal note to Zendesk ticket, when the alert is acknowledged. To do this, go to the Send Alert Updates Back to Zendesk section and define "If alert is acknowledged in Compass, add it as an internal note to ticket in Zendesk".

For other Compass alerts

Use this section to map Compass actions to Zendesk actions when the source of the alert is NOT Zendesk (that is when the alert is created by another integration).
Go to the Create Zendesk Tickets for Compass Alerts section. Map one Compass action to "create a ticket" Zendesk action. The Compass action doesn't have to be "alert is created"; it can be other actions as well.

Sample payload sent from Zendesk

JSON

{
  "action": "create",
  "ticketId": "92",
  "status": "Open",
  "via": "Web Form",
  "title": "Ticket Subject",
  "external_id": "",
  "link": "https://atlas7486.zendesk.com/agent/tickets/92",
  "priority": "High",
  "due_date": "September 11, 2024",
  "ticket_type": "Task",
  "assignee_name": "Dan Morgan",
  "organization_name": "atlas",
  "group_name": "Support",
  "account": "atlas",
  "requester_name": "Dan Morgan",
  "description": "Ticket Description",
  "latest_comment": "Public Message Example"
}

Operations