CustomEvent
A customer-emitted event as the create answers it (1.62.0): its id, type and targets, never its data. The relay later delivers it as an Event of the family custom, source customer.
An object with 9 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
call_id | CallId or null | yes | |
created_at | Timestamp | yes | |
id | EventId | yes | The id the event carries on every surface, assigned once in the request transaction: de-duplicate on it. |
livemode | boolean | yes | True for the live environment. |
object | "custom_event" | yes | |
process_event_id | ProcessEventId or null | yes | The Process event recorded for the Process target; null without one. |
process_id | ProcessInstanceId or null | yes | The instance the request named by id; null for a correlation key or none. |
type | CustomEventType | yes | |
workflow_id | WorkflowId or null | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.