orchestration_status_change - Paxos Documentation

API Documentation

Deposits and Withdrawals

Address Verification

PREVIEW

Identity

Profiles

Sandbox

Orchestrations / Conversions

Taxes

Trading

Rewards

Rewards Engine

Events

API Credentials

Websockets

Webhooks

Problems

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ref_id": "my-orchestration-123",
  "status": "PROCESSING"
}

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

Object Fields

string

required

The Paxos orchestration ID. You can call the GetOrchestration endpoint with this ID to get more details about it.

string

required

The client-specified ID of the orchestration for replay protection and lookup.

string

required

Status of the orchestration:Available options: PROCESSING, COMPLETED, FAILED

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ref_id": "my-orchestration-123",
  "status": "PROCESSING"
}

⌘I

​Object Fields

Object Fields