All events share a common structure, detailed below. The only property that will differ is the payload
object.
In each case, the payload
object and its values will be the same as retrieving the same object directly from the API. For example, the Order Completed event will have the same information as retrieving it from the order status endpoint.
For cases where the attributes of an object have changed, payload
will also contain previous
and current
parameters
Attribute | Type | Description |
---|---|---|
| string | The unique identifier for an event |
| string | The type of event. Type of Events |
| string | Time at which the object was created |
| object | Object containing data associated with the event |
{
"id": "event_4da42927-77f5-4308-a6bf-60c1ed0a4b24",
"type": "{type}",
"timestamp": "2019-01-09T12:14:44.155187291Z",
"payload": {....}
}