Workflows

Crie, gerencie, dispare e monitore workflows automatizados e logs de execução.

CLI vs API key: Tokens CLI são somente leitura para criar, atualizar e excluir workflows — essas escritas exigem X-API-KEY. Trigger é a exceção: aceita uma API key ou um token CLI com capacidade de escrita. Todos os endpoints de workflows são restritos por plano; organizações sem o recurso de workflows podem receber 403 mesmo em leituras.

Resumo dos endpoints

GET /v1/workflows/

Retorna todos os workflows da organização. Paginado com o envelope padrão { count, next, previous, results }.

Parâmetros de consulta

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: sua_api_key"

Resposta (200 OK):

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

Identificador: Cada workflow usa id como identificador — o valor é um UUID (veja Identificadores).

GET /v1/workflows/{uuid}/

Retorna um workflow específico com configuração completa.

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

Resposta (200 OK):

{
  "uuid": "wf-uuid",
  "name": "Onboarding de Novos Funcionários",
  "is_active": true,
  "trigger_type": "event",
  "trigger_config": {
    "event": "organization.user_activated"
  },
  "actions": [
    {
      "type": "send_message",
      "target_type": "user",
      "message": "Bem-vindo ao time! Aqui está o que fazer primeiro..."
    }
  ],
  "created_at": "2026-01-15T00:00:00Z"
}

POST /v1/workflows/

Cria um novo workflow. Auth: somente API key — tokens CLI são rejeitados em POST.

Parâmetros do corpo

curl -X POST "https://api.dailybot.com/v1/workflows/" \
  -H "X-API-KEY: sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Notificação de Deploy",
    "trigger_type": "api_trigger",
    "trigger_config": {},
    "actions": [
      {
        "type": "send_message",
        "target_type": "channel",
        "target_uuid": "channel-uuid",
        "message": "Deploy concluído: {{trigger.body.service}} v{{trigger.body.version}}"
      }
    ]
  }'

Resposta (201 Created):

{
  "uuid": "wf-new-uuid",
  "name": "Notificação de Deploy",
  "is_active": true,
  "trigger_type": "api_trigger",
  "created_at": "2026-04-06T10:00:00Z"
}

DELETE /v1/workflows/{uuid}/

Exclui um workflow.

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

Resposta (204 No Content)

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

Dispara manualmente um workflow cujo tipo de trigger é api_trigger — o trigger projetado para disparo externo. Workflows com qualquer outro tipo de trigger (agendados, eventos de formulário/check-in, comandos, …) mantêm seus próprios caminhos de disparo e retornam 400 workflow_not_triggerable.

Auth: API key ou token CLI com capacidade de escrita. Permissões: restrição por plano + associação à org; a permissão de execução por workflow é aplicada.

Corpo da solicitação

O corpo é opcional:

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

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

Resposta — 202 Accepted (a execução é enfileirada, não executada inline):

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

Códigos de erro

Os mesmos workflows api_trigger também podem ser disparados a partir de um botão interativo de mensagem via buttons[].callback_workflow (opcionalmente com um modal_body cujos campos enviados chegam como {{trigger.fields.<name>}}). Consulte Mensagens do bot para os campos de botões.

Disparado via a API pública, {{trigger.source}} é "api" e as chaves de botão/campo são null ou vazias.

Variáveis de trigger

Os passos do workflow podem referenciar o contexto de disparo através do namespace {{trigger.*}}:

Receitas

Modal → Workflow

Componha modal_body com callback_workflow em um botão interativo: o clique abre o modal e, ao enviar, os valores dos campos são entregues ao workflow como {{trigger.fields.<input.name>}} — sem servidor externo.

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

O workflow (tipo de trigger api_trigger) pode então usar {{trigger.fields.summary}} em qualquer passo — pré-preencher uma resposta de formulário, compor uma mensagem ou alimentar um prompt de IA. Um modal com blocos input e sem callback_url nem callback_workflow é rejeitado (input_without_callback).

Ramificação por valor — vários botões, um workflow

Aponte vários botões para o mesmo UUID de workflow com strings value diferentes e ramifique dentro do workflow em {{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": "O deploy está pronto — escolha uma ação:",
    "target_users": ["user-uuid"],
    "buttons": [
      {
        "label": "Deploy para staging",
        "button_type": "interactive",
        "value": "staging",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      {
        "label": "Deploy para produção",
        "button_type": "interactive",
        "value": "production",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      {
        "label": "Cancelar",
        "button_type": "interactive",
        "value": "cancel",
        "callback_workflow": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ]
  }'

Dentro do workflow, um passo condicional em {{trigger.button_value}} roteia staging, production ou cancel sem manter três definições de workflow separadas.

Para o esquema completo de botões (label, modal_body, response e mais), consulte Mensagens do bot.

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

Retorna os logs de execução de um workflow específico.

Parâmetros de consulta

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

Resposta (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/

Duplica um workflow com um novo nome.

curl -X POST "https://api.dailybot.com/v1/workflows/wf-uuid/duplicate/" \
  -H "X-API-KEY: sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Notificação de Deploy (Cópia)"}'

Resposta (201 Created):

{
  "uuid": "wf-copy-uuid",
  "name": "Notificação de Deploy (Cópia)",
  "is_active": false,
  "created_at": "2026-04-06T10:05:00Z"
}