Batch Trigger Workflow Runs

Start multiple workflow runs in a single request.

1 min read

post/v2/batch/trigger

Request example

curl --request POST \
  --url https://qstash-eu-central-1.upstash.io/v2/batch/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "destination": "<string>",
    "body": "<string>",
    "headers": {}
  }
]'

Response

[
  {
    "workflowRunId": "<string>",
    "workflowCreatedAt": 1,
    "deduplicated": true
  }
]

post/v2/batch/trigger

Authorization

Authorizationstringheaderrequired#

QStash authentication token

1 alternative authorization method available — see the spec for details.

Body

application/json

destinationstringrequired#

The URL of the workflow to trigger.

bodystring#

The raw request payload passed to the workflow endpoint as is. You can access it via request payload parameter on the context object.

headersobject#

HTTP headers to forward to the workflow. You can pass any headers supported in the single trigger API.

Show child attributes

{key}string#

Responses

application/json

Workflow runs triggered successfully

workflowRunIdstring#

The ID of the triggered workflow run.

workflowCreatedAtinteger#

The unix timestamp in milliseconds when the workflow run was created.

deduplicatedboolean#

Whether the workflow run was deduplicated (i.e. a run with the same ID already existed and a new one was not created).

Trigger Workflow Run Cancel Workflow Run