Workflow Docs
AI/LLM: This documentation page is available in plain markdown format at/workflow/latest/docs/reference/interfaces/HandleWebhookOptions.md
HandleWebhookOptions
Interface: HandleWebhookOptions#
Defined in: packages/workflow-core/src/engine/handle-webhook.ts:19
Properties#
payload#
ts
payload: WebhookPayload;Defined in: packages/workflow-core/src/engine/handle-webhook.ts:24
Parsed webhook payload (typically built from the HTTP request body via parseWorkflowRequest).
publish()?#
ts
optional publish: (runId, event) => void | Promise<void>;Defined in: packages/workflow-core/src/engine/handle-webhook.ts:27
Hook called for every event the engine appends, before the webhook handler returns.
Parameters#
runId#
string
event#
Returns#
void | Promise<void>
runStore#
ts
runStore: RunStore;Defined in: packages/workflow-core/src/engine/handle-webhook.ts:21
workflow#
ts
workflow: AnyWorkflowDefinition;Defined in: packages/workflow-core/src/engine/handle-webhook.ts:20