ProcessEvent
A Process event as the api recorded it (1.62.0): its name, source and the instances it matched; its data is content.
An object with 10 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_at | Timestamp | yes | |
custom_event_id | EventId or null | yes | The customer-emitted event it came from, through POST /v1/events; null otherwise. |
data | object or null | yes | Content; null unless the read names include=content, and on every write. |
id | ProcessEventId | yes | |
name | WorkflowName | yes | The name a wait node lists, such as payment.received. |
object | "process_event" | yes | |
process_ids | array of ProcessInstanceId | yes | The instances it matched; empty when none. |
source | ProcessEventSource | yes | |
status | ProcessEventStatus | yes | |
workflow_id | WorkflowId or null | yes | The Process it was delivered to; null for one delivered to an instance by id. |
Used by
The operations whose parameters, request body or responses name this shape directly.