Platform event catalog

Ormuz expose actuellement canonical platform events . All can be delivered by webhook; most can also start a process. Use the catalog below to choose events to track and inspect their data.

Event structure

An event has a common envelope. Its payload then depends on the event-type contract: it may contain a platform object, snapshot, projection, or enriched business result.

JSON

{7 items"id":"evt_0123456789abcdef0123456789abcdef"
"type":"invoice.issued"
"merchant_id":"mer_0123456789abcdef0123456789abcdef"
"company_id":"cmp_0123456789abcdef0123456789abcdef"
"occurred_at":"2026-09-13T08:30:00.000Z"
"context":{2 items"source":"api"
"emitted_at":"2026-09-13T08:30:00.000Z"
}
"payload":{3 items"id":"inv_0123456789abcdef0123456789abcdef"
"object":"invoice"
"status":"issued"
}
}

{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "invoice.issued",
"merchant_id": "mer_0123456789abcdef0123456789abcdef",
"company_id": "cmp_0123456789abcdef0123456789abcdef",
"occurred_at": "2026-09-13T08:30:00.000Z",
"context": {
  "source": "api",
  "emitted_at": "2026-09-13T08:30:00.000Z"
},
"payload": {
  "id": "inv_0123456789abcdef0123456789abcdef",
  "object": "invoice",
  "status": "issued"
}
}

Field	Contract
`id`	Unique occurrence identifier, prefixed `evt_`.
`type`	Canonical event type, for example `invoice.issued`.
`merchant_id`	Merchant concerned when the event is merchant-scoped; may be `null` for an account-level event.
`company_id`	Associated company when the event producer has this identity. The field is absent when not applicable.
`occurred_at`	ISO 8601 UTC timestamp of the occurrence.
`context`	Public correlation context, notably source and, when available, request or correlation identifiers.
`payload`	Data specific to the event type. Do not assume every payload is a complete business object.

GET /v1/events returns the list of available types. Without merchant_id, this list includes the global catalog; with a merchant, extension events are limited to extensions active and accessible for that merchant. Process-trigger contracts are also exposed through event presets. See Introduction to events.

The five orchestration signals process.instance.run_requested, process.instance.retry_requested, process.instance.retry_due, process.instance.timer_due, and process.user_action.completed are observable through webhooks but are not offered as process launchers. This avoids turning internal execution-lifecycle signals into implicit trigger loops.

Companies and contacts

Type	Process trigger	Business reference
`company_group.created`	Yes	See the event contract and associated business object.
`company_group.deleted`	Yes	See the event contract and associated business object.
`company_group.updated`	Yes	See the event contract and associated business object.
`company.assigned_to_group`	Yes	See the event contract and associated business object.
`company.created`	Yes	See the event contract and associated business object.
`company.reactivated`	Yes	See the event contract and associated business object.
`company.removed_from_group`	Yes	See the event contract and associated business object.
`company.risk_score_updated`	Yes	See the event contract and associated business object.
`company.suspended`	Yes	See the event contract and associated business object.
`company.updated`	Yes	See the event contract and associated business object.
`contact_role.certified`	Yes	See the event contract and associated business object.
`contact_role.created`	Yes	See the event contract and associated business object.
`contact_role.expired`	Yes	See the event contract and associated business object.
`contact_role.revoked`	Yes	See the event contract and associated business object.
`contact.created`	Yes	See the event contract and associated business object.
`contact.reactivated`	Yes	See the event contract and associated business object.
`contact.suspended`	Yes	See the event contract and associated business object.
`contact.updated`	Yes	See the event contract and associated business object.

Onboarding and compliance

Type	Process trigger	Business reference
`compliance_check.created`	Yes	See the event contract and associated business object.
`compliance_check.error`	Yes	See the event contract and associated business object.
`compliance_check.expired`	Yes	See the event contract and associated business object.
`compliance_check.failed`	Yes	See the event contract and associated business object.
`compliance_check.passed`	Yes	See the event contract and associated business object.
`compliance_check.review_required`	Yes	See the event contract and associated business object.
`onboarding_case.approved`	Yes	See the event contract and associated business object.
`onboarding_case.cancelled`	Yes	See the event contract and associated business object.
`onboarding_case.company.created`	Yes	See the event contract and associated business object.
`onboarding_case.completed`	Yes	See the event contract and associated business object.
`onboarding_case.individual.created`	Yes	See the event contract and associated business object.
`onboarding_case.rejected`	Yes	See the event contract and associated business object.
`onboarding_case.review_required`	Yes	See the event contract and associated business object.
`risk_score.degraded`	Yes	See the event contract and associated business object.
`risk_score.improved`	Yes	See the event contract and associated business object.

Commerce clients

Type	Process trigger	Business reference
`checkout_session.abandoned`	Yes	See the event contract and associated business object.
`checkout_session.cancelled`	Yes	See the event contract and associated business object.
`checkout_session.completed`	Yes	See the event contract and associated business object.
`checkout_session.created`	Yes	See the event contract and associated business object.
`checkout_session.expired`	Yes	See the event contract and associated business object.
`order.advance_received`	Yes	See the event contract and associated business object.
`order.advance_refunded`	Yes	See the event contract and associated business object.
`order.cancelled`	Yes	See the event contract and associated business object.
`order.completed`	Yes	See the event contract and associated business object.
`order.confirmed`	Yes	See the event contract and associated business object.
`order.created`	Yes	See the event contract and associated business object.
`order.fulfilled`	Yes	See the event contract and associated business object.
`order.updated`	Yes	See the event contract and associated business object.
`return.authorized`	Yes	See the event contract and associated business object.
`return.cancelled`	Yes	See the event contract and associated business object.
`return.created`	Yes	See the event contract and associated business object.
`return.inspected`	Yes	See the event contract and associated business object.
`return.received`	Yes	See the event contract and associated business object.
`return.resolved`	Yes	See the event contract and associated business object.
`return.shipped`	Yes	See the event contract and associated business object.

Invoicing, receivables, and disputes

Type	Process trigger	Business reference
`credit_note.applied`	Yes	See the event contract and associated business object.
`credit_note.created`	Yes	See the event contract and associated business object.
`credit_note.issued`	Yes	See the event contract and associated business object.
`dispute.cancelled`	Yes	See the event contract and associated business object.
`dispute.created`	Yes	See the event contract and associated business object.
`dispute.resolved`	Yes	See the event contract and associated business object.
`due_date_schedule.suspended`	Yes	See the event contract and associated business object.
`invoice.cancelled`	Yes	See the event contract and associated business object.
`invoice.created`	Yes	See the event contract and associated business object.
`invoice.dispute_cleared`	Yes	See the event contract and associated business object.
`invoice.disputed`	Yes	See the event contract and associated business object.
`invoice.due_date_stage_reached`	Yes	An invoice reaches a configured stage of its due-date schedule.
`invoice.issued`	Yes	See the event contract and associated business object.
`invoice.overdue`	Yes	See the event contract and associated business object.
`invoice.paid`	Yes	See the event contract and associated business object.
`invoice.partially_paid`	Yes	See the event contract and associated business object.
`invoice.received`	Yes	See the event contract and associated business object.
`invoice.sent`	Yes	See the event contract and associated business object.
`invoice.terminal_settlement_changed`	Yes	Settlement of an already-terminal document changes and may require business resumption.
`payment_term.created`	Yes	See the event contract and associated business object.
`payment_term.deleted`	Yes	See the event contract and associated business object.
`payment_term.updated`	Yes	See the event contract and associated business object.
`receivable.due_date_stage_reached`	Yes	See the event contract and associated business object.
`receivable.overdue`	Yes	See the event contract and associated business object.
`receivable.updated`	Yes	See the event contract and associated business object.
`receivable.zero`	Yes	The company's open balance reaches zero.

Credit and exposure

Type	Process trigger	Business reference
`credit_exposure.cancelled`	Yes	See the event contract and associated business object.
`credit_exposure.consumed`	Yes	See the event contract and associated business object.
`credit_exposure.consumption_reversed`	Yes	See the event contract and associated business object.
`credit_exposure.expired`	Yes	See the event contract and associated business object.
`credit_exposure.granted`	Yes	See the event contract and associated business object.
`credit_exposure.overconsumed`	Yes	Observed consumption exceeds available capacity; the fact remains recorded and observable.
`credit_exposure.released`	Yes	See the event contract and associated business object.
`credit_exposure.settled`	Yes	See the event contract and associated business object.
`credit_limit.approaching`	Yes	See the event contract and associated business object.
`credit_limit.exceeded`	Yes	See the event contract and associated business object.
`credit_limit.updated`	Yes	See the event contract and associated business object.

Incoming payments

Type	Process trigger	Business reference
`payment_allocation.complete`	Yes	See the event contract and associated business object.
`payment_allocation.partial`	Yes	See the event contract and associated business object.
`payment_refund.cancelled`	Yes	See the event contract and associated business object.
`payment_refund.created`	Yes	See the event contract and associated business object.
`payment_refund.executed`	Yes	See the event contract and associated business object.
`payment_refund.failed`	Yes	See the event contract and associated business object.
`payment_refund.matched`	Yes	See the event contract and associated business object.
`payment.matched`	Yes	See the event contract and associated business object.
`payment.partially_matched`	Yes	Part of the financial movement is reconciled and a balance remains to allocate.
`payment.received`	Yes	See the event contract and associated business object.
`payment.reversed`	Yes	See the event contract and associated business object.
`payment.unmatched`	Yes	See the event contract and associated business object.
`psp_payment.cancelled`	Yes	See the event contract and associated business object.
`psp_payment.created`	Yes	See the event contract and associated business object.
`psp_payment.disputed`	Yes	See the event contract and associated business object.
`psp_payment.failed`	Yes	See the event contract and associated business object.
`psp_payment.partially_funded`	Yes	The PSP payment received part, but not all, of the expected amount.
`psp_payment.succeeded`	Yes	See the event contract and associated business object.
`psp_refund.cancelled`	Yes	See the event contract and associated business object.
`psp_refund.created`	Yes	See the event contract and associated business object.
`psp_refund.failed`	Yes	See the event contract and associated business object.
`psp_refund.succeeded`	Yes	See the event contract and associated business object.

Purchasing and supplier payments

Type	Process trigger	Business reference
`payable.overdue`	Yes	See the event contract and associated business object.
`payable.updated`	Yes	See the event contract and associated business object.
`payable.zero`	Yes	See the event contract and associated business object.
`purchase_order.advance_paid`	Yes	See the event contract and associated business object.
`purchase_order.advance_refunded`	Yes	See the event contract and associated business object.
`purchase_order.approved`	Yes	See the event contract and associated business object.
`purchase_order.cancelled`	Yes	See the event contract and associated business object.
`purchase_order.completed`	Yes	See the event contract and associated business object.
`purchase_order.created`	Yes	See the event contract and associated business object.
`purchase_order.fulfilled`	Yes	See the event contract and associated business object.
`purchase_order.sent`	Yes	See the event contract and associated business object.
`purchase_order.updated`	Yes	See the event contract and associated business object.
`supplier_credit_note.applied`	Yes	See the event contract and associated business object.
`supplier_credit_note.received`	Yes	See the event contract and associated business object.
`supplier_invoice.approved`	Yes	See the event contract and associated business object.
`supplier_invoice.cancelled`	Yes	See the event contract and associated business object.
`supplier_invoice.disputed`	Yes	See the event contract and associated business object.
`supplier_invoice.overdue`	Yes	See the event contract and associated business object.
`supplier_invoice.paid`	Yes	See the event contract and associated business object.
`supplier_invoice.partially_paid`	Yes	See the event contract and associated business object.
`supplier_invoice.received`	Yes	See the event contract and associated business object.
`supplier_invoice.updated`	Yes	See the event contract and associated business object.
`supplier_payment.cancelled`	Yes	See the event contract and associated business object.
`supplier_payment.created`	Yes	See the event contract and associated business object.
`supplier_payment.executed`	Yes	See the event contract and associated business object.
`supplier_payment.failed`	Yes	See the event contract and associated business object.
`supplier_payment.scheduled`	Yes	See the event contract and associated business object.
`supplier_refund.matched`	Yes	See the event contract and associated business object.
`supplier_refund.received`	Yes	See the event contract and associated business object.

Orchestration and approvals

Type	Process trigger	Business reference
`approval_request.created`	Yes	See the event contract and associated business object.
`approval_request.expired`	Yes	See the event contract and associated business object.
`approval_request.resolved`	Yes	See the event contract and associated business object.
`process.instance.replayed`	Yes	See the event contract and associated business object.
`process.instance.retry_due`	No	See the event contract and associated business object.
`process.instance.retry_requested`	No	See the event contract and associated business object.
`process.instance.run_requested`	No	See the event contract and associated business object.
`process.instance.stopped`	Yes	A stop request brought the instance to terminal `stopped` state.
`process.instance.timer_due`	No	See the event contract and associated business object.
`process.user_action.completed`	No	A pending user action was completed and may allow the instance to resume.

Extension events

Extensions publish their own events under the extension.{extension_key}.{event_type}namespace. Their existence, typed inputs, and availability come from each extension's contract, so they are not duplicated in this Core catalog.

Representative examples: extension.stripe.payment_intent.succeeded or a business event from another installed extension. See the Events section of the relevant extension for the exact catalog. Inbound-endpoint configuration is explained in Inbound extension webhooks.

← PreviousIntroduction to events Next →Receive webhooks