Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Activeflow

Create a new activeflow

Endpoint to create a new activeflow.

post/activeflows

Request body

idstring

Optional client-supplied UUID for the new activeflow. If omitted, the server generates one.

flow_idstring

UUID of an existing flow to run. Obtain it from the id field of a GET /flows or POST /flows response. Provide either flow_id or an inline actions array.

variablesobject

Optional flat key-value context seeded into the created activeflow as runtime variables, readable in the flow via ${key}. String values only. Reserved keys starting with 'voipbin.' are ignored. Max 100 keys, 64KB total, 32KB per value.

webhook_uristring

Optional per-activeflow webhook destination URI. When set, activeflow webhook events are delivered additively to this URI in addition to the customer-level webhook destination. Must be a valid http or https URL.

webhook_method'' | 'POST' | 'GET' | 'PUT' | 'DELETE'

HTTP method used to deliver the per-activeflow webhook.

Example request

{
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "variables": {
    "campaign_id": "summer-2026",
    "customer_name": "Jane Doe"
  },
  "webhook_uri": "https://example.com/webhooks/activeflow",
  "webhook_method": "POST"
}

Response

activeflow created successfully.

idstring uuid

Unique identifier for the activeflow.

customer_idstring uuid

The unique identifier of the customer associated with this activeflow. Returned from the GET /customers response.

flow_idstring uuid

The unique identifier of the flow definition. Returned from the POST /flows or GET /flows response.

status'' | 'running' | 'ended'

Status of the activeflow.

reference_type'' | 'ai' | 'api' | 'call' | 'campaign' | 'conversation' | 'transcribe' | 'recording'

Reference type of activeflow.

reference_idstring uuid

The unique identifier of the referenced resource. The actual resource type is determined by reference_type. Returned from the corresponding resource endpoint.

reference_activeflow_idstring uuid

The unique identifier of the referenced activeflow. Returned from the GET /activeflows response.

on_complete_flow_idstring uuid

The unique identifier of the flow to execute on completion. Returned from the POST /flows or GET /flows response.

webhook_uristring

Optional per-activeflow webhook destination URI. When set, activeflow webhook events are delivered additively to this URI in addition to the customer-level webhook destination.

webhook_method'' | 'POST' | 'GET' | 'PUT' | 'DELETE'

HTTP method used to deliver the per-activeflow webhook.

forward_action_idstring uuid

The unique identifier of the next action to execute. References an action id within the current flow's actions array.

tm_createstring date-time

Timestamp when the flow was created.

tm_updatestring date-time

Timestamp when the flow was last updated.

tm_deletestring date-time

Timestamp when the flow was deleted.

Example response

{
  "id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "running",
  "reference_type": "call",
  "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  "reference_activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "webhook_uri": "https://example.com/webhooks/activeflow",
  "webhook_method": "POST",
  "current_action": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "next_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "talk",
    "tm_execute": "2026-01-15T09:30:00.000000Z"
  },
  "forward_action_id": "550e8400-e29b-41d4-a716-446655440000",
  "executed_actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}