The event callback object
A comprehensive list of the event callback resource's attributes and relationships
An event callback object is returned as part of the response body of each successful list or retrieve API call to the /api/event_callbacks
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The event callback unique identifier |
links.self |
| The event callback endpoint URL |
attributes.callback_url |
| The URI of the callback, inherited by the associated webhook. |
attributes.created_at |
| Time at which the resource was created. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes.payload |
| The payload sent to the callback endpoint, including the event affected resource and the specified includes. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.response_code |
| The HTTP response code of the callback endpoint. |
attributes.response_message |
| The HTTP response message of the callback endpoint. |
attributes.signature |
| The callback signature, used to sign the payload. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.webhook |
| The associated webhook. |
meta.mode |
| The resource environment (can be one of |
Last updated