USusenash
Workflow

Trigger Workflow

Changed on

Trigger an active or inactive workflow with optional entity references and input data. Supports sync and async execution modes.

post/v1/workflows/{id}/trigger

Request

Path parameters

idstring required

Request body

jobIdstring nullable

Legacy. Use entity_refs instead.

entityRefsobject nullable

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

inputobject nullable

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

syncboolean

Run the workflow synchronously and return the completed result.

Example request

{
  "entityRefs": {
    "order": "ord_xxx"
  }
}

Changes