Workflows

Create, manage, trigger, and monitor automated workflows and execution logs.

CLI vs API key: CLI tokens are read-only for workflow create, update, and delete — those writes require X-API-KEY. Trigger is the exception: it accepts an API key or a CLI token with write capability. All workflow endpoints are plan-gated; organizations without the workflows feature may receive 403 even on reads.

Endpoints summary

GET /v1/workflows/

Returns all workflows in the organization. Paginated with the standard envelope { count, next, previous, results }.

Query parameters

curl -X GET "https://api.dailybot.com/v1/workflows/?search=onboarding&start_date=2026-06-01&end_date=2026-06-30&page_size=50" \
  -H "X-API-KEY: your_api_key"

Response (200 OK):

{
  "count": 5,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "wf-uuid",
      "name": "New Hire Onboarding",
      "is_active": true,
      "trigger_type": "event",
      "created_at": "2026-01-15T00:00:00Z"
    }
  ]
}

Identifier: Each workflow uses id as its identifier — the value is a UUID (see Identifiers).

GET /v1/workflows/{uuid}/

Returns a specific workflow with full configuration.

curl -X GET "https://api.dailybot.com/v1/workflows/wf-uuid/" \
  -H "X-API-KEY: your_api_key"

Response (200 OK):

{
  "uuid": "wf-uuid",
  "name": "New Hire Onboarding",
  "is_active": true,
  "trigger_type": "event",
  "trigger_config": {
    "event": "organization.user_activated"
  },
  "actions": [
    {
      "type": "send_message",
      "target_type": "user",
      "message": "Welcome to the team! Here's what to do first..."
    }
  ],
  "created_at": "2026-01-15T00:00:00Z"
}

POST /v1/workflows/

Creates a new workflow. Auth: API key only — CLI tokens are rejected on POST.

Body parameters

curl -X POST "https://api.dailybot.com/v1/workflows/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Deploy Notification",
    "trigger_type": "api_trigger",
    "trigger_config": {},
    "actions": [
      {
        "type": "send_message",
        "target_type": "channel",
        "target_uuid": "channel-uuid",
        "message": "Deployment complete: {{trigger.body.service}} v{{trigger.body.version}}"
      }
    ]
  }'

Response (201 Created):

{
  "uuid": "wf-new-uuid",
  "name": "Deploy Notification",
  "is_active": true,
  "trigger_type": "api_trigger",
  "created_at": "2026-04-06T10:00:00Z"
}

DELETE /v1/workflows/{uuid}/

Deletes a workflow.

curl -X DELETE "https://api.dailybot.com/v1/workflows/wf-uuid/" \
  -H "X-API-KEY: your_api_key"

Response (204 No Content)

POST /v1/workflows/{uuid}/trigger/

Manually fires a workflow whose trigger type is api_trigger — the trigger purpose-built for external firing. Workflows with any other trigger type (scheduled, form/check-in events, commands, …) keep their own firing paths and return 400 workflow_not_triggerable.

Auth: API key or CLI token with write capability. Permissions: plan gate + org membership; per-workflow execution permission is enforced.

Request body

Body is optional:

{"payload": {"env": "production", "requested_by": "release-bot"}}

curl -X POST "https://api.dailybot.com/v1/workflows/wf-uuid/trigger/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"payload": {"env": "production"}}'

Response — 202 Accepted (the run is queued, not executed inline):

{"detail": "Workflow trigger accepted.", "workflow_uuid": "wf-uuid", "queued": true}

Error codes

The same api_trigger workflows can also be fired from an interactive message button via buttons[].callback_workflow (optionally with a modal_body whose submitted fields arrive as {{trigger.fields.<name>}}). See Bot messaging for button fields.

Fired via the public API, {{trigger.source}} is "api" and the button/field keys are null or empty.

Trigger variables

Workflow steps can reference the firing context through the {{trigger.*}} namespace:

Recipes

Modal → Workflow

Compose modal_body with callback_workflow on an interactive button: the click opens the modal, and on submit the field values are delivered to the workflow as {{trigger.fields.<input.name>}} — no external server involved.

curl -X POST "https://api.dailybot.com/v1/send-message/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Report an incident:",
    "target_users": ["user-uuid"],
    "buttons": [
      {
        "label": "Report",
        "button_type": "interactive",
        "value": "report",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "modal_body": {
          "title": "New incident",
          "blocks": [
            {
              "type": "input",
              "name": "summary",
              "label": "What happened?",
              "multiline": true,
              "required": true
            }
          ]
        }
      }
    ]
  }'

The workflow (trigger type api_trigger) can then use {{trigger.fields.summary}} in any step — pre-fill a form answer, compose a message, or feed an AI prompt. A modal with input blocks and neither callback_url nor callback_workflow is rejected (input_without_callback).

Value-branching — several buttons, one workflow

Point multiple buttons at the same workflow UUID with different value strings, then branch inside the workflow on {{trigger.button_value}}:

curl -X POST "https://api.dailybot.com/v1/send-message/" \
  -H "X-API-KEY: $DAILYBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Deploy is ready — choose an action:",
    "target_users": ["user-uuid"],
    "buttons": [
      {
        "label": "Deploy to staging",
        "button_type": "interactive",
        "value": "staging",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      {
        "label": "Deploy to production",
        "button_type": "interactive",
        "value": "production",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      {
        "label": "Cancel",
        "button_type": "interactive",
        "value": "cancel",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ]
  }'

Inside the workflow, a conditional step on {{trigger.button_value}} routes staging, production, or cancel without maintaining three separate workflow definitions.

For the full button schema (label, modal_body, response, and more), see Bot messaging.

GET /v1/workflows/{uuid}/execution_logs/

Returns execution logs for a specific workflow.

Query parameters

curl -X GET "https://api.dailybot.com/v1/workflows/wf-uuid/execution_logs/?limit=10" \
  -H "X-API-KEY: your_api_key"

Response (200 OK):

{
  "count": 25,
  "results": [
    {
      "id": "log-uuid",
      "workflow_uuid": "wf-uuid",
      "status": "success",
      "trigger_data": { "source": "api" },
      "executed_at": "2026-04-06T09:00:00Z",
      "duration_ms": 145
    }
  ]
}

POST /v1/workflows/{uuid}/duplicate/

Duplicates a workflow with a new name.

curl -X POST "https://api.dailybot.com/v1/workflows/wf-uuid/duplicate/" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Deploy Notification (Copy)"}'

Response (201 Created):

{
  "uuid": "wf-copy-uuid",
  "name": "Deploy Notification (Copy)",
  "is_active": false,
  "created_at": "2026-04-06T10:05:00Z"
}