Zendesk

Create Zendesk tickets using an Apono webhook

Zendesk is a customer service platform offering tools designed to improve customer engagement and support. It allows businesses to manage customer interactions across multiple channels, including email, social media, and chat.

Through this integration, you will configure an Apono webhook that creates new tickets in Zendesk when user access requests are created, approved, granted, and revoked, or when requests fail.

Prerequisites

Item
Description

Zendesk API Token

Authentication credential used when making requests to the Zendesk API Follow the steps to generate an API token:

  1. Log in to Zendesk Admin Center.

  2. Click Apps and Integrations > Zendesk API > Add API Token.

Zendesk API URL

Route for creating a ticket in your Zendesk instance Example: https://<YOURDOMAIN>.zendesk.com/api/v2/tickets

Configure a webhook

Follow these steps to configure an Apono webhook:

  1. On the Webhooks page, click Add Webhook. The Add Webhook page appears.

  2. Click Request Webhook.

  3. Enter a unique, alphanumeric, user-friendly Request Webhook Name for identifying this webhook.

  4. Click the Status toggle to Active.

  5. From the Method dropdown menu, select a REST method.

  6. In the URL field, enter https://<SUBDOMAIN.zendesk.com/api/v2/tickets. Be sure to replace <SUBDOMAIN> with the Zendesk subdomain for your account.

The webhook URL must adhere to the following requirements:

  • Uses the HTTPS protocol

  • Does not specify any custom ports

  1. In the Body Template field, construct a JSON body for the webhook payload.

{
  "ticket": {
    "comment": {
      "body": "{ \"event_type\": \"{{ event_type }}\", \"id\": \"{{ data.id }}\", \"friendly_id\": \"{{ data.friendly_id }}\", \"requester_id\": \"{{ data.requester.id }}\", \"requester_name\": \"{{ data.requester.name }}\", \"requester_email\": \"{{ data.requester.email }}\", \"justification\": \"{{ data.justification }}\", \"creation_date\": \"{{ data.creation_date }}\", \"access_flow_id\": \"{{ data.access_flow.id }}\", \"access_flow_name\": \"{{ data.access_flow.name }}\", \"access_bundle_id\": \"{{ data.access_bundle.id }}\", \"access_bundle_name\": \"{{ data.access_bundle.id }}\", \"access_groups_integration_name\": \"{{ data.access_groups.[0].integration.name }}\", \"access_groups_integration_type\": \"{{ data.access_groups.[0].integration.type }}\"}"
    },
    "priority": "normal",
    "description": "{{ data.justification }}",
    "subject": "apono app - {{ event_type }} - {{ data.friendly_id }}"
  }
}

Click View event's payload schema to reveal the payload schema and available data fields. You can also refer to the Webhook Payload Schema Reference to read the descriptions of each data field.

  1. Under Headers, use the following Key and Value to set the header. Be sure to replace <ZENDESK_TOKEN> with a base64-encoded authentication string.

Key
Value

Authorization

Bearer <ZENDESK_TOKEN>

  1. From the Triggers dropdown menu, select RequestCreated.

  2. Under Filters, define one or several filter from the listed dropdown menus.

Filters empower admins to control the data transmitted via webhooks, minimizing the amount of data third-party tools receive and reducing unnecessary clutter.

Examples:

  • Send only production requests to your admins' Slack channel.

  • Trigger Okta workflows for events from specific integrations or resource types.

  • Open a ticket in Jira or ServiceNow for manually approved requests.

  1. (Optional) In the Timeout in seconds field, enter the duration in seconds to wait before marking the request as failed.

  2. (Optional) Define Response Validators to verify that the response from the webhook meets specified criteria:

    1. Click + Add. A row of settings appears.

    2. Starting with $.data., enter the Json Path of the JSON parameter.

    3. In the Expected Values field, enter a value and press the Enter key on your keyboard.

    4. Repeat step c to add several expected values.

    5. Repeat steps a-d to add multiple response validators.

  3. Click Test to generate a test event to trigger your webhook. A Test successful or Test failed response status will appear at the bottom of the page. A successful test will send mock data to the target system.

For more information about the test, click View Invocation Data. A panel opens revealing the request, response, and other relevant details.

Should your test fail, view these tips to troubleshoot your webhook.

  1. Click Save Webhook.

The new webhook appears in the Webhooks table. Active webhooks are preceded by a green dot. Inactive webhooks are preceded by a white dot.

Apono will send a call to Zendesk to create a new ticket when the RequestCreated event is triggered.

PreviousServiceNowNextFreshservice

Last updated