Regras de Automação

Configure regras automáticas que executam ações quando determinadas condições são atendidas. Automações podem atribuir conversas, adicionar etiquetas, enviar emails e mais.

Permissão de administrador

Todos os endpoints de regras de automação desta página exigem um token de usuário com perfil administrador na conta. Tokens de agentes não podem listar, criar, consultar, atualizar ou remover regras.

GET/api/v1/accounts/{account_id}/automation_rules

Lista todas as regras de automação da conta.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/automation_rules" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de regras

json

{
  "payload": [
    {
      "id": 1,
      "name": "Auto-atribuir VIP",
      "description": "Atribui conversas de clientes VIP para equipe especializada",
      "event_name": "conversation_created",
      "account_id": 1,
      "conditions": [...],
      "actions": [...]
    }
  ]
}

POST/api/v1/accounts/{account_id}/automation_rules

Cria uma nova regra de automação.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da regra
`description`	`string`	Nao	Descrição da regra
`event_name`	`string`	Sim	Evento gatilho: conversation_created, conversation_updated, conversation_resolved, conversation_opened ou message_created
`conditions`	`array`	Sim	Array não vazio de condições para ativar a regra. Ausente ou vazio retorna 422.
`actions`	`array`	Sim	Array não vazio de ações a executar. Ausente ou vazio retorna 422.

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/automation_rules" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Auto-atribuir por inbox",
    "event_name": "conversation_created",
    "conditions": [
      {
        "attribute_key": "inbox_id",
        "filter_operator": "equal_to",
        "values": [1],
        "query_operator": null
      }
    ],
    "actions": [
      {
        "action_name": "assign_team",
        "action_params": [2]
      },
      {
        "action_name": "add_label",
        "action_params": ["whatsapp"]
      }
    ]
  }'

200Regra criada. Diferente das demais operações, o POST retorna o objeto da regra diretamente, sem wrapper payload.

GET/api/v1/accounts/{account_id}/automation_rules/{id}

Retorna os detalhes de uma regra de automação.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/automation_rules/1" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Regra encontrada, envolta em { payload: { ... } }.

PATCH/api/v1/accounts/{account_id}/automation_rules/{id}

Atualiza uma regra de automação existente.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Nao	Nome da regra
`description`	`string`	Nao	Descrição da regra
`event_name`	`string`	Nao	Evento gatilho
`active`	`boolean`	Nao	Ativa ou desativa a regra
`conditions`	`array`	Nao	Condições atualizadas
`actions`	`array`	Nao	Ações atualizadas

200Regra atualizada, envolta em { payload: { ... } }.

DELETE/api/v1/accounts/{account_id}/automation_rules/{id}

Remove uma regra de automação.

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/automation_rules/1" \
  -H "api_access_token: YOUR_TOKEN"

200Regra removida; resposta sem corpo.

Condições e Ações

Eventos Gatilho

Evento	Descrição
`conversation_created`	Quando uma nova conversa é criada
`conversation_updated`	Quando uma conversa é atualizada
`conversation_resolved`	Quando uma conversa é resolvida
`conversation_opened`	Quando uma conversa é (re)aberta
`message_created`	Quando uma nova mensagem é recebida

Ações Disponíveis

Ação	Descrição
`assign_agent`	Atribuir a um agente específico
`assign_team`	Atribuir a uma equipe
`remove_assigned_agent`	Remover o agente atribuído
`remove_assigned_team`	Remover a equipe atribuída
`add_label`	Adicionar etiqueta
`remove_label`	Remover etiqueta
`send_message`	Enviar uma mensagem na conversa
`send_email_to_team`	Enviar email para a equipe
`send_email_transcript`	Enviar transcrição por email
`send_webhook_event`	Disparar um webhook
`send_attachment`	Enviar um anexo
`mute_conversation`	Silenciar notificações da conversa
`change_status`	Alterar status (open, resolved, pending)
`resolve_conversation`	Resolver a conversa
`open_conversation`	Abrir ou reabrir a conversa
`pending_conversation`	Mover a conversa para pendente
`snooze_conversation`	Adiar a conversa
`change_priority`	Alterar prioridade
`add_private_note`	Adicionar nota privada
`move_pipeline_card_to_stage`	Mover o card do Pipeline para outro estágio
`set_pipeline_card_owner`	Definir o responsável do card do Pipeline
`mark_pipeline_card_won`	Marcar o card do Pipeline como ganho
`mark_pipeline_card_lost`	Marcar o card do Pipeline como perdido
`schedule_follow_up`	Agendar um follow-up
`add_sla`	Aplicar uma política de SLA