Skip to main content
POST
Trigger Workflow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
jobId
string | null

Legacy. Use entity_refs instead.

entityRefs
Entityrefs · object | null

Entity type to ID mapping. Supported types: order, job, delivery, task, route.

Example:
input
Input · object | null

Arbitrary JSON payload accessible in workflow templates via {{ trigger_metadata. }}.

sync
boolean
default:false

Run the workflow synchronously and return the completed result.

Response

422 - application/json

Unprocessable Content

error
NashErrorDetails · object
required
response_status
string
required
RequestID
string
required