A workflow's context is an object provided by the route function.
The context object provides:
- Workflow APIs – functions for defining workflow steps.
- Workflow Run Properties – request payload, request headers, and other metadata.
Context Object Properties#
The request payload passed to the workflow run via trigger() call.
The request headers passed to the workflow run via trigger() call.
The unique identifier of the current workflow run.
The public URL of the workflow endpoint.
The URL used for workflow failure callback.
If a failure function is defined, this is the same as the workflow's url.
The environment variables available to the workflow.
The QStash client instance used by the workflow endpoint.
The labels attached to the current workflow run, if set in client.trigger. Defaults to an empty array when no label was set.
Deprecated. Use labels instead. When a run has multiple labels, this only
returns the first one.
Context Object Functions#
You can use the functions exposed by context object to define workflow steps.