Custom Objects Events

This API is in early access. Complete the Objects Events API EAP registration form to start using it.

Custom objects events track the user actions executed on object records and object types. The following actions trigger an event:

  • creating an object
  • updating an object
  • deleting an object

JSON Format

Object Events are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
created_at string true false The time the event was created
event_source string true false Currently, always "zen:sunshine"
event_type string true false The type of the event. Possible values: "create_object", "update_object", or "delete_object"
id string true false Automatically assigned when the event is created
object_id string true false The id of the object record
object_type string true false The type of object
properties object true false The attributes object of the object record
Example
{
  "created_at": "2019-03-29T01:09:00.000Z",
  "event_source": "zen:sunshine",
  "event_type": "create_object",
  "id": "5a93a697-51bf-11e9-bcd6-63c9631d595a",
  "object_id": "5a7967d6-51bf-11e9-bcd6-e1d3e751878e",
  "object_type": "test_object",
  "properties": {
    "attributes": {
      "id": "10",
      "name": "Macbook Air"
    }
  }
}

List Custom Object Events

  • GET /api/sunshine/objects/events

Retrieves all create, update, delete events for custom object records and types for a given account.

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/sunshine/objects/events \
  -v -u {email_address}:{password}
Example Response
Status 200 OK

{
  "data": [
    {
      "created_at": "2019-03-29T01:09:00.000Z",
      "event_source": "zen:sunshine",
      "event_type": "create_object",
      "id": "5a93a697-51bf-11e9-bcd6-63c9631d595a",
      "object_id": "5a7967d6-51bf-11e9-bcd6-e1d3e751878e",
      "object_type": "test_object",
      "properties": {
        "attributes": {
          "id": "10",
          "name": "Macbook Air"
        }
      }
    }
  ],
  "links": {
    "next": null,
    "previous": null
  }
}