Zendesk

Flow Designer has built-in steps to help you integrate Zendesk into your critical event management and incident response flows.

Zendesk Steps

The following steps are available:

  • Create Ticket: automatically create a new ticket in Zendesk, populating it with information from the original event or previous steps in the flow.
  • Update Ticket: automatically update an existing ticket as information about the event or alert changes.
  • Add Comment: automatically add a comment to an existing ticket, with new information from other steps in the flow.

There's also a built-in Zendesk trigger you can use to initiate flows with requests from Zendesk. This trigger is also used in our packaged Zendesk workflow.

In the example above, the flow creates a Zendesk ticket when a certain response is selected, including alert information in the ticket. The flow creates a channel in Slack using the ticket ID in the name and posts a message with details about the alert so the team can start collaborating on a resolution. The Slack channel name is added to an internal comment in Zendesk. Finally, the Slack channel URL is added as an External ID in the Zendesk ticket for traceability.

Create Ticket

Use the Create Ticket step to automatically create a new ticket in Zendesk. Map outputs from previous steps to the inputs to complete the incident details.

Update Ticket

Use the Update Ticket step to automatically update the information on an existing ticket. Map outputs of previous steps to the inputs to determine which ticket to update and what details to change.

Add Comment

Use the Add Comment step to automatically add an internal note or public reply to an existing ticket. Map outputs of previous steps to the inputs to create the comment and determine which ticket to comment on.

Zendesk Alerts trigger

Flow Designer includes a built-in Zendesk Alerts trigger that initiates a flow when it receives a request from Zendesk. You can configure a Zendesk target to send the request when your configured conditions are met.

This trigger is used in our packaged Zendesk workflow. If you're using Zendesk in your incident management processes, you might want to check it out. The workflow instructions have additional information on automatically determining recipients of notifications based on user or group assignment in Zendesk. The workflow already has steps in its flows to update and add comments to Zendesk tickets with information from the xMatters alert.

Configure Zendesk to send requests to the trigger URL

The following sections provide detailed instructions on how to configure Zendesk to send alerts to xMatters.

Set recipients in the trigger URL

The trigger expects the recipients in the trigger URL. When you copy the URL from xMatters, it includes the recipients parameter: recipients=<yourname>. Of course, you don’t want to receive all the alerts.

To change the recipients, swap out your name for the people or groups you want to target.

  • For URL authentication, use an ampersand to attach recipients. For example, if you want to notify Emma Pearson and the on-call members in the group responsible for the Antares service, you'd add &recipients=epearson,antares to the URL.
  • For other authentication types, use a question mark to attach recipients. For example, if you want to notify Barry Gull and the on-call members in the group responsible for the Cassiopeia service, you'd add ?recipients=bgull,cassiopeia to the URL.

Remember to URL-encode any special characters, including spaces, in your group names.

We recommend using groups so you can take advantage of the xMatters group features — rotations, escalations, and absences — to reach the right on-call people to jump on an issue.

Outputs