Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paxos.com/llms.txt

Use this file to discover all available pages before exploring further.

This object is returned by the Get Event API when the event type is orchestration.processing, orchestration.completed, or orchestration.failed.

​
Object Fields

​
id
string
required
The Paxos orchestration ID. You can call the GetOrchestration endpoint with this ID to get more details about it.
​
ref_id
string
required
The client-specified ID of the orchestration for replay protection and lookup.
​
status
string
required
Status of the orchestration:Available options: PROCESSING, COMPLETED, FAILED
​
orchestration_rule_id
string
The ID of the orchestration rule that triggered this orchestration. This field will not be present for ad-hoc orchestrations. (optional)
{
  "id": "ee1a802f-7557-4c59-b833-9a1ef29630d5",
  "orchestration_rule_id": "86d3929f-0090-45e5-8195-dbcf63c43eec",
  "ref_id": "orchestration_id.ee1a802f-7557-4c59-b833-9a1ef29630d5",
  "status": "COMPLETED"
}