Sign in
Incremental Export

Incremental Ticket Event Export

Returns a stream of changes that occurred on tickets, excluding events occuring within one minute of the request. 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:

  • Exporting ticket events in Using the Incremental Exports API
  • Time-based incremental exports in Using the Incremental Exports API

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": "<div class="zd-comment"><p dir="auto">This is a comment</p>",
    "public": true,
    "attachments": [],
    "audit_id": 91048994468,
    "created_at": "2009-06-25T10:15:18Z",
    "event_type": "Comment"
  },
  ...
],
...
get/api/v2/incremental/ticket_events

Response

Success response

countinteger
end_of_streamboolean
end_timeinteger
next_pagestring nullable

Example response

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

Changes