This reference documentation provides a list of available event types for Zendesk webhooks and their related request payloads. For more information about webhooks, see Creating and monitoring webhooks.

Supported event types

Supported event types are grouped by domain:

Note: To send webhook requests based on ticket activity, connect the webhook to a trigger or automation instead. See Creating and monitoring webhooks.

Event schema

HTTP requests for Zendesk event webhooks use a similar JSON payload schema with shared properties. Events with the same event type use the same payload schema. An example event payload:

{  "type": "zen:event-type:user.active_changed",  "account_id": 12514403,  "id": "2b24ef10-19d4-4740-93cf-8f98ec4776c0",  "time": "2099-07-04T05:33:18Z",  "zendesk_event_version": "2022-06-20",  "subject": "zen:user:6596848315901",  "detail": {    "created_at": "2099-07-04T05:27:58Z",    "email": "[email protected]",    "external_id": "",    "default_group_id": "0",    "id": "6596848315901",    "organization_id": "0",    "role": "end-user",    "updated_at": "2099-07-04T05:33:18Z"  },  "event": {    "current": false,    "previous": true  }}

Top-level properties

All event payloads contain the following top-level properties.

PropertyData typeDescription
account_idintegerZendesk account id associated with the event
detailobjectResource created or changed by the event. See Detail object
eventobjectContains information about the event's changes. See Event object
idstringUnique id for the event
subjectstringContains the event's domain and an id for the resource created or changed by the event
timestringTimestamp for when the event occurred
typestringType of activity the event recorded
zendesk_event_versionstringEvent schema version. Possible value is "2022-06-20"

Detail object

The detail object contains information about the resource created or changed by the event. The object's properties vary based on the event's domain. You can determine an event's domain from the event's type prefix.

Zendesk event domainType prefixDetail properties
Articlezen:event-type/articleArticle detail properties
Community postzen:evnt-type/community_postCommunity post detail properties
Organizationzen:event-type/organizationOrganization detail properties
Userzen:event-type/userUser detail properties
Agent Availabilityzen:event-type/agentAgent availability detail properties
Omnichannel routing configurationzen:event-type/omnichannel_configOmnichannel routing configuration detail properties

Event object

The event object contains information about the event's changes. The object's properties vary based on event type.

Zendesk event domainEvent types
ArticleArticle event types
Community postCommunity post event types
OrganizationOrganization event types
UserUser event types
Agent AvailabilityAgent Availability event types
Omnichannel Routing ConfigurationOmnichannel routing configuration event types