# The event object

An event object is returned as part of the response body of each successful list, retrieve or update API call to the `/api/events` endpoint.

## Fields

| Field                                    | Type       | Description                                                                                                                                                                                         |
| ---------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                 | `string`   | `events`                                                                                                                                                                                            |
| **id**                                   | `string`   | The event unique identifier                                                                                                                                                                         |
| links.**self**                           | `string`   | The event endpoint URL                                                                                                                                                                              |
| attributes.**name**                      | `string`   | The event's internal name.                                                                                                                                                                          |
| attributes.**\_trigger**                 | `boolean`  | Send this attribute if you want to force webhooks execution for this event. Cannot be passed by sales channels.                                                                                     |
| attributes.**created\_at**               | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**               | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**                 | `string`   | 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**         | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**                  | `object`   | 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.                                        |
| relationships.**webhooks**               | `array`    | The associated webhooks.                                                                                                                                                                            |
| relationships.**last\_event\_callbacks** | `array`    | The last associated event callbacks.                                                                                                                                                                |
| relationships.**event\_stores**          | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                            | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |