Incremental Ticket Event Export

GET {{baseUrl}}/api/v2/incremental/ticket_events?start_time=<integer>

Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. For more information, see:

You can include comments in the event stream by using the comment_events sideload. See Sideloading below. If you don't specify the sideload, any comment present in the ticket update is described only by Boolean comment_present and comment_public object properties in the event's child_events array. The comment itself is not included.

Allowed For

  • Admins

Sideloading

The endpoint supports the comment_events sideload. Any comment present in the ticket update is listed as an object in the event's child_events array. Example:

"child_events": [
  {
    "id": 91048994488,
    "via": {
      "channel": "api",
      "source": {"from":{},"to":{},"rel":null}},
    "via_reference_id":null,
    "type": "Comment",
    "author_id": 5031726587,
    "body": "This is a comment",
    "html_body": "&lt;div class="zd-comment"&gt;&lt;p dir="auto"&gt;This is a comment&lt;/p&gt;",
    "public": true,
    "attachments": [],
    "audit_id": 91048994468,
    "created_at": "2009-06-25T10:15:18Z",
    "event_type": "Comment"
  },
  ...
],
...

Request Params

KeyDatatypeRequiredDescription
start_timestring(Required) The time to start the incremental export from

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;count&quot;:1,&quot;end_of_stream&quot;:true,&quot;end_time&quot;:1601357503,&quot;next_page&quot;:&quot;https://example.zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503&quot;,&quot;ticket_events&quot;:[{&quot;id&quot;:926256957613,&quot;instance_id&quot;:1,&quot;metric&quot;:&quot;agent_work_time&quot;,&quot;ticket_id&quot;:155,&quot;time&quot;:&quot;2020-10-26T12:53:12Z&quot;,&quot;type&quot;:&quot;measure&quot;}]}