This reference documentation provides a list of available events and example schemas which are streamed to Amazon EventBridge using the Zendesk Events Connector.

An event is a description of an activity that has occurred in a Zendesk account. Currently, events can only be streamed from the Zendesk ticketing system. Support for other types of events will be added in the future.

For more information about sending events to Amazon EventBridge:

Rate limit

Sending events to your AWS account using the Zendesk Events Connector does not impact your REST API rate limits. The Events Connector has a rate limit of 5000 events sent per minute. For availability, see the Zendesk Suite plan limits.

Event schema structure

The schema for events contains information describing the type of event and the time it happened. Depending on the event type, there is additional information about the ticket affected by the event, and the ids of associated objects such as requesters and assignees.

The event schema is in JSON format as shown in the following example.


{  "version": "0",  "id": "5cabfa42-9882-4f86-9a13-be7097e63171",  "detail-type": "Support Ticket: Description Changed",  "source": "aws.partner/",  "account": "123456789012",  "time": "2019-05-25T01:23:48Z",  "region": "us-east-1",  "resources": ["Support Ticket"],  "detail": {    "ticket_event": {      "meta": {        "version": "1.0",        "occurred_at": "2019-05-25T01:23:45.465719851Z",        "ref": "1-1234567890",        "sequence": {          "id": "ED28AEC3317694CB34AF1A28CFA0D3A8",          "position": 1,          "total": 1        },        "actor_id": 20978392      },      "type": "Description Changed",      "previous": "first description",      "current": "second description",      "ticket": {        "id": 35436,        "created_at": "2019-05-20T22:55:29.465719851Z",        "updated_at": "2019-05-25T01:23:45.563482870Z",        "type": "question",        "priority": "low",        "status": "open",        "requester_id": 20978392,        "submitter_id": 76872,        "assignee_id": 235323,        "organization_id": 10002,        "group_id": 98738,        "brand_id": 123,        "form_id": 6876543,        "external_id": "TEST1234",        "tags": [          "enterprise"        ],        "via": {          "channel": "web"        }      }    }  }}

Top level properties

All events contain the following top level properties.

PropertyData typeDescription
versionstringEvent version (not currently used)
idintegerEvent id generated by Amazon EventBridge
detail-typestringDescribes the product type and event type
sourcestringPartner event source in your Zendesk account
accountintegerAWS account id
timedateDate and time when the event passed through Amazon EventBridge
regionstringSource AWS region
resourcesstringDescribes the Zendesk object
detailobjectEvent-specific payload. See Detail object

Detail object

The detail object is a wrapper for the event's payload. The detail object contains an object property with a key ending in _event. This property's full key and content depends on the event's domain.

Zendesk event domainProperty keyContent
Chatchat_eventChat event properties
Ticketticket_eventTicket event properties
Organizationorganization_eventOrganization event properties
Useruser_eventUser event properties

The ticket_event, organization_event, and user_event properties also contain common event properties.

Common event properties

In addition to domain-specific content, the ticket_event, organization_event, and user_event properties also contain the following properties.

actor_idnumberid of the user that triggered the event. Actions by an automation have an actor_id of -1 (system user). Only ticket_event contains this property
metaobjectMetadata for the event
meta.occurred_atstringDate and time the event occurred in Zendesk
meta.refstringZendesk identifier for the event
meta.sequenceobjectContains information about the event's sequence. A single action can trigger a sequence of events
meta.sequence.idstringid of the action that triggered the event. Events with the same sequence id were triggered by the same action
meta.sequence.positionnumberOrder of the event within the sequence. Zendesk doesn't guarantee this order
meta.sequence.totalnumberNumber of events in the sequence
meta.versionstringVersion for the event type
typestringEvent type