Anatomy of a webhook request
A webhook sends an HTTP request to a specified URL in response to activity in Zendesk Support. These requests use specific headers, HTTP methods, formats, and payloads.
Request headers
All webhook requests include the following HTTP headers:
x-zendesk-account-id: 123456x-zendesk-webhook-id: 01F1KRFQ6BG29CNWFR60NK5FNYx-zendesk-webhook-invocation-id: 8350205582x-zendesk-webhook-signature: EiqWE3SXTPQpPulBV6OSuuGziIishZNc1VwNZYqZrHU=x-zendesk-webhook-signature-timestamp: 2021-03-25T05:09:27Z
You can use the x-zendesk-webhook-signature and
x-zendesk-webhook-signature-timestamp headers to verify that a request came
from Zendesk. See Verifying webhook
authenticity.
You can also add basic or bearer authentication to webhook requests. This lets you authenticate the requests with a third-party system. See Webhook security and authentication.
HTTP method, format, and payload
A webhook request's HTTP method, format, and payload vary based on how the webhook subscribes to activity in Zendesk Support:
Requests for Zendesk events
A webhook that's subscribed to one or more Zendesk events always sends requests using the POST HTTP method. The request includes a JSON payload that contains the event's data. You can't change the HTTP method or the payload for the request. For more information about event payload schemas, see Webhook event types.
Requests for triggers and automations
If a webhook is connected to a trigger or automation, you can customize the HTTP method, format, and payload for the webhook's requests. You define the HTTP method and request format when you create the webhook. See Creating a webhook. You define the request payload when you connect the webhook to a trigger or automation. For more information, see Connecting a webhook to a trigger or automation.