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

An event consists of a JSON object with the following properties.

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

List Custom Objects 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": [
    {
      "id": "5a93a697-51bf-11e9-bcd6-63c9631d595a",
      "event_type": "create_object",
      "event_source": "zen:sunshine",
      "object_type": "test_object",
      "object_id": "5a7967d6-51bf-11e9-bcd6-e1d3e751878e",
      "properties": {
        "attributes": {
          "id": "10",
          "name": "Macbook Air"
        }
      },
      "created_at": "2019-03-29T01:09:00.000Z"
    },
    {
      ...
    }
  ],
  "links": {
    "previous": null,
    "next": null
  }
}