Event
One event (1.52.0, ADR 0051): the Webhook envelope, the data of an event on the Organization event stream, and an entry of the event log.
An object with 14 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
api_version | "v1" | yes | |
created_at | Timestamp | yes | When the change the event describes committed. |
data | map of any | yes | The type's data, typed in the catalog (GET /v1/event-types, and the *EventData components). In PHI mode only its structural and identifier fields travel; from 1.62.0 a custom event's data is the customer's, which in PHI mode travels empty and GET /v1/events/{event_id} answers with include=data. |
family | EventFamily | yes | |
id | EventId | yes | Assigned once in the producing transaction and kept across retries and replays: de-duplicate on it. |
livemode | boolean | yes | True for the live environment. |
object | "event" | yes | |
organization_id | OrganizationId | yes | |
project_id | ProjectId or null | yes | The resource's Project: the default Project until Projects ship, null for a resource of the Organization itself, such as a Member. |
sequence | integer | yes | The per-Organization order the relay assigns (ADR 0051 rule 7). Events about one subject keep their causal order; across subjects the order is relay order. A Webhook receiver uses it to discard a stale update. From 1.64.0, stated: a webhook.test envelope, which takes no place in the log, carries the latest relayed sequence of the Organization, at least 1, so it is never a new position in the order. |
source | EventSource | yes | |
subject | EventSubject | yes | |
targets | EventTargets or null | no | On a custom event (1.62.0): the Call and the Process its request named; absent on every other type. |
type | string | yes | The event type, one of EventTypeName, or from 1.62.0 a CustomEventType of the family custom; a reader treats a type it does not know as an event it does not interpret. |
Used by
The operations whose parameters, request body or responses name this shape directly.