Sign in

Retrieve workflow run

Retrieve detailed information for a specific workflow run by ID.

get/v1/activity/workflow-runs/{workflowRunId}

Path parameters

workflowRunIdstring required

Response

idstring required

Workflow run id

workflowIdstring required

Workflow identifier

workflowNamestring required

Workflow name

organizationIdstring required

Organization identifier

environmentIdstring required

Environment identifier

internalSubscriberIdstring required

Internal subscriber identifier

subscriberIdstring

External subscriber identifier

status'processing' | 'completed' | 'error' required

Workflow run status

deliveryLifecycleStatus'pending' | 'sent' | 'errored' | 'skipped' | 'canceled' | 'merged' | 'delivered' | 'interacted' required

Workflow run delivery lifecycle status

triggerIdentifierstring required

Trigger identifier

transactionIdstring required

Transaction identifier

createdAtstring required

Creation timestamp

updatedAtstring required

Update timestamp

severity'high' | 'medium' | 'low' | 'none' required

Severity

criticalboolean required

Critical flag

contextKeysstring[]

Context (single or multi) in which the workflow run was executed

payloadobject required

Trigger payload

overridesobject

Trigger overrides passed to the original workflow trigger

Example response

{
  "topics": [
    {
      "_id": "64da692e9a94fb2e6449ad06",
      "key": "product-updates",
      "name": "Product Updates",
      "data": {
        "category": "product",
        "priority": 1
      },
      "createdAt": "2023-08-15T00:00:00.000Z",
      "updatedAt": "2023-08-15T00:00:00.000Z"
    }
  ]
}

Changes

Changed in 1 of the 13 revisions of this API.1

  • 16de7466b1df1See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added