Automations

create_conversation_rule

Write

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.

Permission

automations:write

Operation

automations.rules.create

Parameters

namestringrequired

triggerstringrequired

NEW_MESSAGECONVERSATION_OPENEDCONVERSATION_IDLETAG_ADDED

conditionsobject[]optional

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[].fieldstringrequired

channelstatuscontactNamemessageBodytagNameidleHoursidleDays

conditions[].operatorstringrequired

equalsnot_equalscontainsgtelte

conditions[].valuestring | integerrequired

actionsobject[]required

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

isActivebooleanoptional

orderintegeroptional

get_automation

Read

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).

Permission

automations:read

Operation

automations.flows.get

Module

automations

Parameters

automationIdstringrequired

get_automation_execution

Read

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.

Permission

automations:read

Operation

automations.executions.get

Module

automations

Parameters

executionIdstringrequired

list_automation_executions

Read

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.

Permission

automations:read

Operation

automations.executions.list

Module

automations

Parameters

automationIdstringoptional

statusstringoptional

runningsuccesserrortimeout

dateFromstringoptional

AAAA-MM-DD (Brasília).

dateTostringoptional

AAAA-MM-DD, inclusivo.

limitintegeroptional

list_automations

Read

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).

Permission

automations:read

Operation

automations.flows.list

Module

automations

Parameters

isActivebooleanoptional

triggerstringoptional

list_conversation_rules

Read

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.

Permission

automations:read

Operation

automations.rules.list

Parameters

isActivebooleanoptional

retry_automation_execution

WriteNeeds approval

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.

Permission

automations:write

Operation

automations.executions.retry

Module

automations

Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.

Parameters

executionIdstringrequired

run_automation

WriteNeeds approval

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.

Permission

automations:write

Operation

automations.flows.run

Module

automations

Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.

Parameters

automationIdstringrequired

inputobjectoptional

contactIdstringoptional

conversationIdstringoptional

dealIdstringoptional

set_automation_active

Write

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).

Permission

automations:write

Operation

automations.flows.set_active

Module

automations

Parameters

automationIdstringrequired

activebooleanrequired

set_conversation_rule_active

Write

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.

Permission

automations:write

Operation

automations.rules.set_active

Parameters

ruleIdstringrequired

activebooleanrequired

update_conversation_rule

Write

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

Permission

automations:write

Operation

automations.rules.update

Parameters

ruleIdstringrequired

namestringoptional

triggerstringoptional

NEW_MESSAGECONVERSATION_OPENEDCONVERSATION_IDLETAG_ADDED

conditionsobject[]optional

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[].fieldstringrequired

channelstatuscontactNamemessageBodytagNameidleHoursidleDays

conditions[].operatorstringrequired

equalsnot_equalscontainsgtelte

conditions[].valuestring | integerrequired

actionsobject[]optional

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

orderintegeroptional