Event Types
This catalog and the payload schema are generated from the same reviewed Cortex API authority snapshot: 865c6e284bf10cfbea9888c88a3e3794c29cd652 (API 18.303.2). Every JSON fixture below is synthetic and validates against that schema.
Notifications are compact lookup hints, not full order, invite, search, or result representations. The internal routing eventType is not a payload field. Use idType to interpret id, then retrieve the exact resource with the documented authenticated request.
| Event | ID type | Trigger |
|---|---|---|
ORDER_STATUS_CHANGE | order | Emitted when the persisted order status changes. An IN_DISPUTE to COMPLETE transition also emits ORDER_DISPUTE_RESOLVED. |
ORDER_SCORE_CHANGE | order | Emitted after a score update. ID-verification PDF flow can delay this notification until the report PDF is attached. |
ORDER_CUSTOM_SCORE_CHANGE | order | Emitted when customScore changes. |
ORDER_DISPUTE_RESOLVED | order | Emitted for an IN_DISPUTE to COMPLETE transition, immediately before the corresponding ORDER_STATUS_CHANGE notification. |
ORDER_ERROR | order | Emitted for a covered county-dispatch error when the optional order.error event is enabled. |
VOUCHER_REDEEMED | invite | Emitted after an invite-backed order is created and its postback webhook is registered. The payload ID is the invite ID, not the new order ID. |
VOUCHER_ACCEPTED | invite | Emitted on the invite-acceptance path when the optional voucher.accepted event is enabled. |
VOUCHER_STARTED | invite | Emitted once for the eligible transition to STARTED when the optional voucher.started event is enabled. The status change and durable queue job share a transaction. |
VOUCHER_CANCELED | invite | Emitted when an invite transitions to CANCELED and the optional voucher.canceled event is enabled. |
VOUCHER_EXPIRED | invite | Emitted after the configured expiry is reached for an invite with a postback URL, unless it is already COMPLETE or CANCELED. |
VOUCHER_OPTED_OUT | invite | Emitted when an invite transitions to opt-out and has a postback URL. |
BEAM_INPUT_CREATED | beamInput | Accepted by the simulation endpoint. No production emitter was found in the reviewed source; confirm the live trigger with the API owner before relying on it. |
MONITORING_REPORT_GENERATED | report | Queued after a monitoring-report PDF is attached. |
Optional event configuration
VOUCHER_ACCEPTED, VOUCHER_STARTED, VOUCHER_CANCELED, and ORDER_ERROR are disabled unless explicitly enabled. Other configuration and postback prerequisites are described with each event.
Set metadata.webhooks.events[eventType].enabled on the package or organization. Explicit package settings take precedence: across relevant packages, any true enables the event. If no package entry configures it, the organization boolean applies; otherwise the default is false. The keys use internal event types, not the uppercase payload event names:
{
"webhooks": {
"events": {
"voucher.started": {
"enabled": true
},
"order.error": {
"enabled": true
}
}
}
}These settings control optional emission. They do not disable signing.
Event fixtures
Order status changed (ORDER_STATUS_CHANGE)
Emitted when the persisted order status changes. An IN_DISPUTE to COMPLETE transition also emits ORDER_DISPUTE_RESOLVED.
Order ID and order additionalMetadata; metadata.delta is included when a pre-update snapshot is available.
Retrieve with GET /v1/orders/{id} when processing requires more than the compact notification.
{
"id": "0bb0f6f8-459f-482a-952e-7caf029517f6",
"idType": "order",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"metadata": {
"delta": [
{
"op": "replace",
"path": "/status",
"before": "PENDING",
"after": "COMPLETE"
}
]
},
"event": "ORDER_STATUS_CHANGE",
"eventDate": "2026-11-19T15:07:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Order score changed (ORDER_SCORE_CHANGE)
Emitted after a score update. ID-verification PDF flow can delay this notification until the report PDF is attached.
Order ID and order additionalMetadata. The direct update path can include a delta; the PDF-attachment path omits metadata.
Retrieve with GET /v1/orders/{id} when processing requires more than the compact notification.
{
"id": "0bb0f6f8-459f-482a-952e-7caf029517f6",
"idType": "order",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"metadata": {
"delta": [
{
"op": "replace",
"path": "/score",
"before": null,
"after": "ID_VERIFIED"
}
]
},
"event": "ORDER_SCORE_CHANGE",
"eventDate": "2026-11-19T15:07:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Order custom score changed (ORDER_CUSTOM_SCORE_CHANGE)
Emitted when customScore changes.
Order ID and order additionalMetadata; metadata.delta is included when a pre-update snapshot is available.
Retrieve with GET /v1/orders/{id} when processing requires more than the compact notification.
{
"id": "0bb0f6f8-459f-482a-952e-7caf029517f6",
"idType": "order",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "ORDER_CUSTOM_SCORE_CHANGE",
"eventDate": "2026-11-19T15:07:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Order dispute resolved (ORDER_DISPUTE_RESOLVED)
Emitted for an IN_DISPUTE to COMPLETE transition, immediately before the corresponding ORDER_STATUS_CHANGE notification.
Order ID and order additionalMetadata; metadata.delta is included when a pre-update snapshot is available.
Retrieve with GET /v1/orders/{id} when processing requires more than the compact notification.
{
"id": "0bb0f6f8-459f-482a-952e-7caf029517f6",
"idType": "order",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"metadata": {
"delta": [
{
"op": "replace",
"path": "/status",
"before": "IN_DISPUTE",
"after": "COMPLETE"
},
{
"op": "replace",
"path": "/score",
"before": "REVIEW_REQUIRED",
"after": "REVIEW_PASS"
}
]
},
"event": "ORDER_DISPUTE_RESOLVED",
"eventDate": "2026-11-19T15:07:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}County search dispatch failed (ORDER_ERROR)
Emitted for a covered county-dispatch error when the optional order.error event is enabled.
additionalMetadata contains stage, searchType, requestedSearchId, dispatchedSearchId, and a sanitized error object. No delta.
Retrieve with GET /v1/orders/{id} when processing requires more than the compact notification.
{
"id": "0bb0f6f8-459f-482a-952e-7caf029517f6",
"idType": "order",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"stage": "COUNTY_DISPATCH",
"searchType": "county",
"requestedSearchId": "5e7a9c1b-3d5f-4a2c-9e6b-8d0f2a4c6e75",
"dispatchedSearchId": "9e3c5a7b-1d4f-4b8e-a2c6-5f7d9b1e3a68",
"error": {
"message": "County search dispatch failed",
"codes": []
}
},
"event": "ORDER_ERROR",
"eventDate": "2026-11-19T15:07:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Invite order created (VOUCHER_REDEEMED)
Emitted after an invite-backed order is created and its postback webhook is registered. The payload ID is the invite ID, not the new order ID.
Invite ID and the invite metadata copied to the order; no delta.
Retrieve with GET /v1/vid/invites/{id} when processing requires more than the compact notification.
{
"id": "8faf4d07-6fec-43b8-a32c-cd549c30b5e9",
"idType": "invite",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "VOUCHER_REDEEMED",
"eventDate": "2026-11-19T15:05:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Invite accepted (VOUCHER_ACCEPTED)
Emitted on the invite-acceptance path when the optional voucher.accepted event is enabled.
Invite ID and invite clientMetadata or an empty object; no delta.
Retrieve with GET /v1/vid/invites/{id} when processing requires more than the compact notification.
{
"id": "8faf4d07-6fec-43b8-a32c-cd549c30b5e9",
"idType": "invite",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "VOUCHER_ACCEPTED",
"eventDate": "2026-11-19T15:01:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Applicant started verification (VOUCHER_STARTED)
Emitted once for the eligible transition to STARTED when the optional voucher.started event is enabled. The status change and durable queue job share a transaction.
Invite ID and invite clientMetadata or an empty object; no delta.
Retrieve with GET /v1/vid/invites/{id} when processing requires more than the compact notification.
{
"id": "8faf4d07-6fec-43b8-a32c-cd549c30b5e9",
"idType": "invite",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "VOUCHER_STARTED",
"eventDate": "2026-11-19T15:02:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Invite canceled (VOUCHER_CANCELED)
Emitted when an invite transitions to CANCELED and the optional voucher.canceled event is enabled.
Invite ID and invite clientMetadata or an empty object; no delta.
Retrieve with GET /v1/vid/invites/{id} when processing requires more than the compact notification.
{
"id": "8faf4d07-6fec-43b8-a32c-cd549c30b5e9",
"idType": "invite",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "VOUCHER_CANCELED",
"eventDate": "2026-11-19T15:03:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Invite expired (VOUCHER_EXPIRED)
Emitted after the configured expiry is reached for an invite with a postback URL, unless it is already COMPLETE or CANCELED.
Invite ID and invite clientMetadata or an empty object; no delta.
Retrieve with GET /v1/vid/invites/{id} when processing requires more than the compact notification.
{
"id": "8faf4d07-6fec-43b8-a32c-cd549c30b5e9",
"idType": "invite",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "VOUCHER_EXPIRED",
"eventDate": "2026-12-19T15:00:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Invite opted out (VOUCHER_OPTED_OUT)
Emitted when an invite transitions to opt-out and has a postback URL.
Invite ID and invite clientMetadata or an empty object; no delta.
Retrieve with GET /v1/vid/invites/{id} when processing requires more than the compact notification.
{
"id": "8faf4d07-6fec-43b8-a32c-cd549c30b5e9",
"idType": "invite",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "VOUCHER_OPTED_OUT",
"eventDate": "2026-11-19T15:03:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Beam input created (BEAM_INPUT_CREATED)
Accepted by the simulation endpoint. No production emitter was found in the reviewed source; confirm the live trigger with the API owner before relying on it.
Beam input ID and additionalMetadata; no delta. The fixture demonstrates the simulation-supported compact shape.
No public BeamInput retrieval route was established in this review; do not guess one.
{
"id": "4a8c2e6f-0b3d-4d5a-8f1c-6e2a4c8b0d93",
"idType": "beamInput",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"clientReferenceId": "APP-1042"
},
"event": "BEAM_INPUT_CREATED",
"eventDate": "2026-11-19T15:04:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Monitoring report generated (MONITORING_REPORT_GENERATED)
Queued after a monitoring-report PDF is attached.
id is the monitoring report ID. additionalMetadata contains orderId and enrollmentId; no delta.
Retrieve with GET /v1/monitoring/reports/{id} when processing requires more than the compact notification.
{
"id": "7a2c4e6b-9d1f-4a3c-8e5b-2d4f6a8c0e31",
"idType": "report",
"organizationId": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",
"additionalMetadata": {
"orderId": "0bb0f6f8-459f-482a-952e-7caf029517f6",
"enrollmentId": "2b6d8f0a-4c1e-4a3b-8d5f-7e9a1c3b5d02"
},
"event": "MONITORING_REPORT_GENERATED",
"eventDate": "2026-11-19T15:08:00.000Z",
"svixAppId": "app_2z7K9synthetic000000000001"
}Delta availability
metadata.delta is possible only for ORDER_STATUS_CHANGE, ORDER_SCORE_CHANGE, ORDER_CUSTOM_SCORE_CHANGE, and ORDER_DISPUTE_RESOLVED. It is omitted when no pre-update snapshot exists and can be an empty array when a snapshot exists but no mapped fields changed. See Webhook Payload Deltas.
Future event names
The schema intentionally describes this reviewed snapshot. No public forward-compatibility policy for unknown future event names was established. A durable receiver can record and quarantine an unrecognized event for review instead of executing an unknown business action; do not describe that implementation choice as a Cerebrum delivery guarantee.