> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflows (Beta)

> The Workflows API lets you programmatically create, manage, and trigger automated workflows.

<Note>The Workflows API is currently in **beta**. Endpoints may change without notice.</Note>

The Workflows API lets you programmatically create, manage, and trigger automated workflows. Workflows are multi-step automations that run in response to events, schedules, webhooks, or manual triggers.

## Key Concepts

* **Workflow** — A named automation with a trigger type and one or more versions
* **Version** — Each edit creates a new version; only one version is active at a time
* **Run** — A single execution of a workflow, with status tracking and duration
* **Trigger type** — What starts the workflow: manual, AI-triggered, cron, webhook, form, or event-based
* **Action type** — A step in the workflow (e.g. `ask-ai`, `send-webhook`, `tag-ticket`)
* **Block** — A control-flow structure (`if-else`, `switch`) that branches execution

## Workflow Lifecycle

1. **Discover** available action and trigger types via the definitions endpoint
2. **Validate** your workflow blocks before creating
3. **Create** a workflow (saved as inactive draft)
4. **Activate** to make the workflow live
5. **Trigger** manually or let it fire automatically based on its trigger type
6. **Monitor** runs and their statuses

## Replies with quick reply suggestions

The `outbound-reply-to-ticket` action accepts an optional `quickReplySuggestions` array of plain-text labels, for example `["Track transfer", "Cancel transfer", "Speak to someone"]`. Omit it or pass `[]` to send the existing reply without buttons. Discover the action and its input schema through [Definitions](./definitions), then [validate](./validate) the workflow before activating it.

Use at most **3 unique, non-empty labels**, each up to **20 characters**. A selection becomes a normal customer reply; it does not pause or branch the sending workflow. Suggestions support the OpenCX web widget, directly connected WhatsApp, Messenger and Instagram channels, and API clients that render message options. Unsupported delivery paths fail the step instead of silently dropping the suggestions.

On WhatsApp, the rendered message body is limited to **1,024 characters**, and the customer's **24-hour reply window** must be open. Outside that window, send an approved template. See [workflow quick reply suggestions](/whatsapp/messaging-rules#quick-reply-suggestions-in-workflows) for setup, translation behavior, and channel limits.

## Available Endpoints

<CardGroup>
  <Card title="Definitions" icon="book" href="./definitions">
    List available action and trigger types
  </Card>

  <Card title="Validate" icon="check" href="./validate">
    Validate workflow blocks before creating
  </Card>

  <Card title="Create Workflow" icon="plus" href="./create">
    Create a new workflow
  </Card>

  <Card title="List Workflows" icon="list" href="./list">
    List all workflows
  </Card>

  <Card title="Get Workflow" icon="magnifying-glass" href="./get">
    Get a specific workflow with full details
  </Card>

  <Card title="Update Workflow" icon="pen" href="./update">
    Update a workflow (creates new version)
  </Card>

  <Card title="Delete Workflow" icon="trash" href="./delete">
    Delete a workflow
  </Card>

  <Card title="Activate" icon="play" href="./activate">
    Activate a workflow version
  </Card>

  <Card title="Deactivate" icon="pause" href="./deactivate">
    Deactivate a workflow
  </Card>

  <Card title="Trigger Workflow" icon="bolt" href="./trigger">
    Manually trigger a workflow
  </Card>

  <Card title="List Runs" icon="clock-rotate-left" href="./list_runs">
    List workflow execution runs
  </Card>

  <Card title="Get Run" icon="magnifying-glass" href="./get_run">
    Get a specific run
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.