orchestration_status_change

Event object returned for orchestration status change events

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

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: PENDING, PROCESSING, COMPLETED, FAILED, REJECTED

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)

Rule-triggered Orchestration (COMPLETED)

{
  "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"
}