Automações

create_conversation_rule

Escrita

Cria uma regra de conversa. Gatilhos: NEW_MESSAGE (mensagem do cliente), CONVERSATION_OPENED, CONVERSATION_IDLE (conversa parada; use idleHours/idleDays), TAG_ADDED. Ações: assign_to, change_status, add_tag, send_message, send_followup, send_delayed_message, send_sequence, create_deal, send_webhook. Nasce desligada (a não ser que isActive venha true): confirme com a pessoa e ligue com set_conversation_rule_active.

Permissão

automations:write

Operação

automations.rules.create

Parâmetros

namestringobrigatório

triggerstringobrigatório

NEW_MESSAGECONVERSATION_OPENEDCONVERSATION_IDLETAG_ADDED

conditionsobject[]opcional

Todas precisam bater (E). Campos por gatilho: NEW_MESSAGE channel/status/contactName/messageBody; CONVERSATION_OPENED channel/status/contactName; CONVERSATION_IDLE channel/status/idleHours/idleDays; TAG_ADDED channel/status/tagName. channel: WHATSAPP, WEBCHAT, INSTAGRAM, MESSENGER, EMAIL, TELEGRAM, API.

conditions[].fieldstringobrigatório

channelstatuscontactNamemessageBodytagNameidleHoursidleDays

conditions[].operatorstringobrigatório

equalsnot_equalscontainsgtelte

conditions[].valuestring | integerobrigatório

actionsobject[]obrigatório

Na ordem. Mensagens saem pelo canal da conversa e respeitam a janela de 24 h do WhatsApp e o descadastro.

isActivebooleanopcional

orderintegeropcional

get_automation

Leitura

Um fluxo: gatilho e configuração do gatilho, etapas na ordem do desenho (tipo e nome), entradas esperadas (inputSchema, para run_automation), integrações usadas e o endereço do webhook de entrada (sem o segredo).

Permissão

automations:read

Operação

automations.flows.get

Módulo

automations

Parâmetros

automationIdstringobrigatório

get_automation_execution

Leitura

Uma execução: entrada, saída, erro e o log de cada etapa (status, tempo, erro e prévia do resultado) — para entender onde e por que falhou.

Permissão

automations:read

Operação

automations.executions.get

Módulo

automations

Parâmetros

executionIdstringobrigatório

list_automation_executions

Leitura

Execuções dos fluxos, mais recentes primeiro: de um fluxo ou de todos, por status (running, success, error, timeout) e período. Para saber o que falhou e em qual etapa, abra com get_automation_execution.

Permissão

automations:read

Operação

automations.executions.list

Módulo

automations

Parâmetros

automationIdstringopcional

statusstringopcional

runningsuccesserrortimeout

dateFromstringopcional

AAAA-MM-DD (Brasília).

dateTostringopcional

AAAA-MM-DD, inclusivo.

limitintegeropcional

list_automations

Leitura

Fluxos do construtor de automações: nome, o que fazem, gatilho (AI_TOOL, WEBHOOK_IN, DEAL_STAGE, NEW_MESSAGE, CONVERSATION_OPEN, SCHEDULED, MANUAL, sinais de venda…), se estão ligados, se há mudança não publicada e as execuções (total, sucesso, erro, última).

Permissão

automations:read

Operação

automations.flows.list

Módulo

automations

Parâmetros

isActivebooleanopcional

triggerstringopcional

list_conversation_rules

Leitura

Regras de conversa da empresa (se acontecer X na conversa e as condições baterem, faz Y): gatilho, condições, ações e se está ligada, na ordem em que rodam.

Permissão

automations:read

Operação

automations.rules.list

Parâmetros

isActivebooleanopcional

retry_automation_execution

EscritaPede aprovação

Roda de novo uma execução que deu erro ou estourou o tempo, com a mesma entrada, contato e conversa. Pela chave de API vai para aprovação.

Permissão

automations:write

Operação

automations.executions.retry

Módulo

automations

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

executionIdstringobrigatório

run_automation

EscritaPede aprovação

Roda um fluxo ligado de gatilho MANUAL, AI_TOOL ou WEBHOOK_IN, com as entradas do inputSchema e, se fizer sentido, o contato, a conversa ou o negócio. Conta no limite mensal de execuções. Pela chave de API vai para aprovação; o resultado sai em get_pending_action_status.

Permissão

automations:write

Operação

automations.flows.run

Módulo

automations

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

automationIdstringobrigatório

inputobjectopcional

contactIdstringopcional

conversationIdstringopcional

dealIdstringopcional

set_automation_active

Escrita

Liga ou desliga um fluxo. Só liga um fluxo já publicado no editor, e liga a última versão publicada (mudança não publicada continua no rascunho).

Permissão

automations:write

Operação

automations.flows.set_active

Módulo

automations

Parâmetros

automationIdstringobrigatório

activebooleanobrigatório

set_conversation_rule_active

Escrita

Liga ou desliga uma regra de conversa. Ligada, ela age sozinha em toda conversa que bater — confirme com a pessoa antes de ligar uma que manda mensagem.

Permissão

automations:write

Operação

automations.rules.set_active

Parâmetros

ruleIdstringobrigatório

activebooleanobrigatório

update_conversation_rule

Escrita

Edita uma regra de conversa: nome, gatilho, ordem, condições ou ações. `conditions` e `actions` trocam a lista inteira (mande todas).

Permissão

automations:write

Operação

automations.rules.update

Parâmetros

ruleIdstringobrigatório

namestringopcional

triggerstringopcional

NEW_MESSAGECONVERSATION_OPENEDCONVERSATION_IDLETAG_ADDED

conditionsobject[]opcional

Todas precisam bater (E). Campos por gatilho: NEW_MESSAGE channel/status/contactName/messageBody; CONVERSATION_OPENED channel/status/contactName; CONVERSATION_IDLE channel/status/idleHours/idleDays; TAG_ADDED channel/status/tagName. channel: WHATSAPP, WEBCHAT, INSTAGRAM, MESSENGER, EMAIL, TELEGRAM, API.

conditions[].fieldstringobrigatório

channelstatuscontactNamemessageBodytagNameidleHoursidleDays

conditions[].operatorstringobrigatório

equalsnot_equalscontainsgtelte

conditions[].valuestring | integerobrigatório

actionsobject[]opcional

Na ordem. Mensagens saem pelo canal da conversa e respeitam a janela de 24 h do WhatsApp e o descadastro.

orderintegeropcional