API & events
Use the REST API to request or retrieve Ormuz state, outbound webhooks to receive platform events, and extension endpoints to ingest provider signals. These surfaces share the same public objects and events but serve different exchange directions.
Machine surfaces
| Surface | Direction | Responsibility |
|---|---|---|
API REST /v1 | Your system → Ormuz | Create, read, or evolve a resource according to its public contract; launch or operate artifacts exposed by the API. |
| Outbound webhooks | Ormuz → your system | Receive selected platform-event occurrences for a merchant. |
| Extension webhooks | Provider → Ormuz | Receive an external signal under the extension contract, then expose it as an extension event without inventing an Ormuz business fact. |
Processes may then consume typed inputs from events that declare trigger capability. A provider event and a canonical Ormuz change remain two distinct facts: the former may trigger a process that eventually establishes the latter.
Choose the right surface
| Need | Start with |
|---|---|
| Create or retrieve a business object | API reference |
| Authenticate a machine client | Authentication and conventions |
| Be notified when an Ormuz fact occurs | Outbound webhooks |
| Choose a Core event type | Event catalog |
| Ingest a Stripe, ERP, or other provider event | Inbound extension webhooks |
| Prepare a client for contract evolution | Versioning |
References
Authentication and conventionsAPI keys, bearer tokens, permission sets, identifiers, metadata, pagination, and errors.API referencePublic REST contracts: endpoints, parameters, bodies, and responses.Introduction to eventsEvent envelope, typed payloads, and use as a trigger.Platform event catalogExhaustive catalog derived from the public Core event registry.Receive webhooksCreate an outbound endpoint, verify signatures, and track delivery attempts.Inbound extension webhooksConfigure the provider to send its events to the endpoint declared by its extension.Contract versioning/v1 boundary, additive changes, breaking changes, and client compatibility practices.