Custom object events

You can enable custom object events to trigger a flow by specifying in the JobSpec object the event_source as "support" and event_type as the tag associated with the event. See Trigger events for more information.

The table and sections below lists all the supported custom object events with the tag and expected payload content.

event_type	Event payload
customobject.CustomObjectRecordCreated	Custom Object Record Created
customobject.CustomObjectRecordChanged	Custom Object Record Changed
customobject.CustomObjectRecordDeleted	Custom Object Record Deleted

Custom Object Record Created

A custom object record was created.

Example

{
  "account_id": 12345,
  "integration_key": "my_integration_key",
  "subdomain": "my_zendesk_subdomain",
  "input": {
    "custom_object_event": {
      "meta": {
        "version": "2.0",
        "occurred_at": "2020-12-02T05:19:54Z",
        "ref": "4-4809584"
      },
      "type": "Custom Object Record Created",
      "custom_object_record": {
        "account_id": 7806004,
        "custom_object_key": "car",
        "external_id": null,
        "id": "01GDXYEY1FQYN066VHF49YHJ21",
        "name": "My car 1",
        "custom_object_fields": {
          "color": "white",
          "make": "Tesla",
          "model": "Y"
        },
        "created_at": "2022-09-26T22:25:10Z",
        "created_by_user_id": 10001,
        "updated_at": "2022-09-26T22:25:10Z",
        "updated_by_user_id": 10001
      }
    }
  }
}

Custom Object Record Changed

A custom object record was changed.

Example

{
  "account_id": 12345,
  "integration_key": "my_integration_key",
  "subdomain": "my_zendesk_subdomain",
  "input": {
    "custom_object_event": {
      "meta": {
        "version": "2.0",
        "occurred_at": "2020-12-02T05:19:54Z",
        "ref": "4-4809584"
      },
      "type": "Custom Object Record Changed",
      "custom_object_record": {
        "account_id": 7806004,
        "custom_object_key": "car",
        "external_id": null,
        "id": "01GDXYEY1FQYN066VHF49YHJ21",
        "name": "My Tesla",
        "custom_object_fields": {
          "color": "white",
          "make": "Tesla",
          "model": "Y"
        },
        "created_at": "2022-09-26T22:25:10Z",
        "created_by_user_id": 10001,
        "updated_at": "2022-09-26T22:25:10Z",
        "updated_by_user_id": 10001
      }
    }
  }
}

Custom Object Record Deleted

A custom object record was deleted.

Example

{
  "account_id": 12345,
  "integration_key": "my_integration_key",
  "subdomain": "my_zendesk_subdomain",
  "input": {
    "custom_object_event": {
      "meta": {
        "version": "2.0",
        "occurred_at": "2020-12-02T05:16:04Z",
        "ref": "1-4818276"
      },
      "type": "Custom Object Record Deleted",
      "custom_object_record_id": "01J3EHE9CMRR6VPT5FT8P6MMRQ"
    }
  }
}