UNPKG

workflow

Version:

Workflow SDK - Build durable, resilient, and observable workflows

35 lines (29 loc) • 1.42 kB
--- title: "workflow/api" description: Runtime functions to inspect runs, start workflows, and manage hooks. type: overview summary: Explore runtime functions for starting workflows, inspecting runs, and managing hooks. --- API reference for runtime functions from the `workflow/api` package. ## Functions The API package is for access and introspection of workflow data to inspect runs, start new runs, and manage hooks. <Cards> <Card href="/docs/api-reference/workflow-api/start" title="start()"> Start/enqueue a new workflow run. </Card> <Card href="/docs/api-reference/workflow-api/resume-hook" title="resumeHook()"> Resume a workflow by sending a payload to a hook. </Card> <Card href="/docs/api-reference/workflow-api/resume-webhook" title="resumeWebhook()"> Resume a workflow by sending a `Request` to a webhook. </Card> <Card href="/docs/api-reference/workflow-api/get-hook-by-token" title="getHookByToken()"> Get hook details and metadata by its token. </Card> <Card href="/docs/api-reference/workflow-api/get-run" title="getRun()"> Get workflow run status and metadata without waiting for completion. </Card> </Cards> <Callout type="info"> Looking for `getWorld()` and the World SDK? They are exported from `workflow/runtime` — see the [`workflow/runtime` reference](/docs/api-reference/workflow-runtime). </Callout>