
# Workflows

A workflow is a multi-step scenario that runs on a Bitrix24 document. Unlike CRM triggers, which change an entity's state instantly, a workflow can include pauses to wait for external events, conditional branching, parallel branches, and delays. Typical scenarios: approval chains, automatic document preparation, scheduled notifications.

Lifecycle: launch (`start`) → execution → instance inspection (`list`) → pause handling via an event (`event`) or a log entry (`activity-log`) → termination (`terminate`).

Bitrix24 API: `bizproc.workflow.*`, `bizproc.event.*`, `bizproc.activity.*`
Scope: `bizproc`

## Operations

- [Start a workflow](./workflows/start.md) — `POST /v1/workflows/start`
- [List running workflows](./workflows/list.md) — `GET /v1/workflows`
- [Terminate a workflow](./workflows/terminate.md) — `DELETE /v1/workflows/:id`
- [Send an event to a workflow](./workflows/event.md) — `POST /v1/workflows/event`
- [Write to the workflow log](./workflows/activity-log.md) — `POST /v1/workflows/activity-log`

## Templates and automation rules require an authorization key

`GET/POST/PATCH/DELETE /v1/bizproc-templates` and `GET/POST/PATCH/DELETE /v1/bizproc-robots` work **only with an authorization key** `vibe_app_…` together with the `Authorization: Bearer` header. With an API key `vibe_api_…` the request is rejected with `403 OAUTH_REQUIRED` — these methods need application context. More about key types: [Keys and authorization](/docs/keys-auth).

The workflow launch, stop, and monitoring endpoints (`/v1/workflows/*`) work with both key types.

## See also

- [CRM Automation](/docs/automation) — section overview and a full example
- [Triggers](/docs/automation/triggers) — targeted automation triggering
- [Business process templates](/docs/entities/bizproc-templates) — list of templates for `templateId`
