Skip to main content
Workflow endpoints live under the /workflow prefix. Use them to manage workflow definitions, run executions synchronously or asynchronously, and receive trigger callbacks. Pass your credential in the Authorization header; user PATs (pat_) also need X-Anyreach-Org. See Authentication.
Every path is prefixed with /workflow. The product pages on executions and public execution reference these same endpoints.

Workflows

MethodPathDescription
GET/workflow/workflowsList workflows
POST/workflow/workflowsCreate a workflow
GET/workflow/workflows/{id}Get one workflow
PUT/workflow/workflows/{id}Update a workflow
DELETE/workflow/workflows/{id}Delete a workflow

Executions

MethodPathDescription
GET/workflow/workflow-executionsList executions (filter by workflow_id)
GET/workflow/workflow-executions/{id}Get one execution, including each step’s input and output
POST/workflow/workflow-executionsRun a workflow synchronously and return the result
POST/workflow/workflow-executions/asyncStart an execution and return immediately

Authoring helpers

MethodPathDescription
POST/workflow/code-steps/previewRun a Code step in a sandbox to preview its output

Public execution

A workflow marked public can be invoked without authentication — for browser embeds and external webhooks.
MethodPathDescription
POST/workflow/public/workflows/{workflow_id}/{version}/executeExecute a published, public workflow. No Authorization header.
See Public execution for the security implications.

Trigger webhooks

External systems start workflows through trigger webhooks. You configure these from the builder rather than calling them directly.
MethodPathDescription
POST/workflow/webhooks/anyreach/triggers/{trigger_id}Fire an Anyreach-native trigger
POST/workflow/webhooks/pipedream/triggers/{trigger_id}Fire a Pipedream-backed trigger

Action and trigger registry

The Anyreach registry powers the Action step’s app catalog and trigger configuration.
MethodPathDescription
GET/workflow/anyreach/actions/entitiesList available action entities
GET/workflow/anyreach/actions/{action_key}Get one action’s definition
POST/workflow/anyreach/actions/remote-optionsResolve dynamic option lists for an action’s fields
POST/workflow/anyreach/actions/testTest-run an action with sample input

Example: run a workflow synchronously

curl -X POST https://api.anyreach.ai/workflow/workflow-executions \
  -H "Authorization: Bearer $ANYREACH_TOKEN" \
  -H "X-Anyreach-Org: $ANYREACH_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "wf_...",
    "input_data": { "name": "Alice", "email": "alice@example.com" }
  }'

Workflows

Build workflows in the visual editor.

Sync vs async execution

When to run synchronously or in the background.