Fluxos
Catálogo de nós
Todos os tipos de nó que um fluxo aceita, com a configuração, as saídas e as chaves de saída de cada um.
Esta página é gerada a partir do mesmo catálogo que GET /workflows/node-types devolve, então traz exatamente os nós que a API aceita hoje. Para entender como os nós se ligam, leia antes o guia Fluxos.
Como ler cada nó
| Item | O que significa |
|---|---|
| Tipo | O valor de type do nó no grafo. |
| Categoria | O valor de category no catálogo. |
| Fluxos | Os tipos de fluxo (messages ou voice) que aceitam o nó. |
| Precisa de conversa | O nó só tem efeito quando a execução roda numa conversa; numa execução de lead ele segue sem efeito. |
| Escopo do gatilho | Só nos gatilhos: conversation dispara apenas nas conversas pelas quais o fluxo responde; global dispara para todo o workspace, conforme a configuração do gatilho. |
| Comportamento no teste | O valor de testBehavior. Em sends_message a mensagem é sempre simulada; em external_call a chamada real só acontece com confirmRealCalls; em waits o teste descreve a espera sem esperar. |
| Configuração | Os campos de config. Um campo obrigatório vazio bloqueia a publicação (NODE_MISSING_REQUIRED_FIELD). |
| Saídas | Os ids que as conexões que saem do nó levam em label. Toda saída obrigatória precisa de uma conexão para publicar. |
| Chaves de saída | O que o nó grava para os passos seguintes, lido com {{node.<id>.<chave>}} ou {{last.<chave>}}. |
Índice
| Nó | Tipo | Categoria | Fluxos |
|---|---|---|---|
| Chamado por agente IA | trigger_agent_call | Gatilhos | messages |
| Aniversário | trigger_birthday | Gatilhos | messages |
| Ligação Recebida | trigger_call_received | Gatilhos | voice |
| Ligação de Campanha | trigger_campaign_call | Gatilhos | voice |
| Primeira Mensagem | trigger_first_message | Gatilhos | messages |
| Formulário respondido | trigger_form_submitted | Gatilhos | messages |
| Mensagem Recebida | trigger_message_received | Gatilhos | messages |
| Entrou na etapa | trigger_stage_added | Gatilhos | messages |
| Webhook | trigger_webhook | Gatilhos | messages |
| Enviar E-mail | action_send_email | Mensagens | messages e voice |
| Enviar e-mail (plataforma) | action_send_platform_email | Mensagens | messages e voice |
| Adicionar linha na planilha | action_add_sheet_row | Ações | messages e voice |
| Gerenciar Etiqueta | action_assign_label | Ações | messages |
| Atribuir ao Membro | action_assign_member | Ações | messages |
| Cancelar mensagens agendadas | action_cancel_scheduled_messages | Ações | messages e voice |
| Verificar Disponibilidade | action_check_calendar_availability | Ações | messages e voice |
| Consentimento | action_consent | Ações | messages |
| Criar evento na agenda | action_create_calendar_event | Ações | messages e voice |
| Exportar mensagens para planilha | action_export_messages_sheet | Ações | messages |
| Finalizar Conversa | action_finish_conversation | Ações | messages |
| Requisição HTTP | action_http_request | Ações | messages e voice |
| Gerenciar Negociação | action_manage_opportunity | Ações | messages |
| Mover Etapa | action_move_stage | Ações | messages |
| Tocar Áudio | action_play_audio | Ações | voice |
| Responder ao agente | action_reply_to_agent | Ações | messages |
| Reagendar evento na agenda | action_reschedule_calendar_event | Ações | messages |
| Agendar mensagem | action_schedule_message | Ações | messages e voice |
| Enviar formulário | action_send_form | Ações | messages |
| Enviar Opções | action_send_interactive | Ações | messages |
| Enviar Mídia | action_send_media | Ações | messages |
| Enviar pesquisa | action_send_survey | Ações | messages |
| Enviar Template | action_send_template | Ações | messages e voice |
| Enviar Texto | action_send_text | Ações | messages |
| Transferir conversa | action_transfer_department | Ações | messages |
| Transferir para Fila | action_transfer_to_queue | Ações | voice |
| Atualizar Lead | action_update_lead | Ações | messages |
| Agente IA | action_ai_agent | IA | messages |
| Código (JavaScript) | action_code | Lógica | messages e voice |
| Formatar Data/Hora | action_format_date | Lógica | messages e voice |
| Hora Atual | action_get_current_time | Lógica | messages e voice |
| Loop / Iteração | action_loop | Lógica | messages e voice |
| Definir Variável | action_set_variable | Lógica | messages e voice |
| Condição | condition_branch | Condições | messages e voice |
| Canal | condition_channel | Condições | messages |
| Verificar Etiqueta | condition_check_label | Condições | messages |
| Verificar Negociação | condition_check_opportunity | Condições | messages |
| Verificar Etapa | condition_check_stage | Condições | messages |
| Lead tem consentimento? | condition_consent | Condições | messages |
| Filtro | condition_filter | Condições | messages e voice |
| Classificar Texto | condition_text_match | Condições | messages e voice |
| Aguardar Tecla | wait_dtmf | Esperas | voice |
| Aguardar Duração | wait_duration | Esperas | messages |
| Aguardar Resposta | wait_for_reply | Esperas | messages |
| Esperar Horário | wait_schedule | Esperas | messages |
| Fim | end | Fim | messages e voice |
| Plano de Fundo | decoration_background | Decoração | messages |
Gatilhos
Chamado por agente IA
Dispara quando um agente de IA executa este fluxo na conversa em que está atendendo.
- Tipo:
trigger_agent_call - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
global - Comportamento no teste:
trigger
Quando usar: Inicia o fluxo quando um agente de IA chama a ferramenta Executar fluxo durante um atendimento, sempre na conversa atual.
Como funciona: Disponibiliza {{input.<campo>}} com os campos declarados (validados antes de iniciar) e {{agent.id}} / {{agent.name}}. Use o nó Responder ao agente para devolver um resultado ao agente.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
inputs | agent_call_inputs | Não | Campos recebidos do agente. Cada campo vira um parâmetro da ferramenta Executar fluxo: nome (minúsculas, dígitos e _), tipo (string, number, boolean, object, array), descrição, obrigatório e exemplo. |
Configuração padrão
{
"inputs": []
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
input.<campo> | não informado | Valor de cada campo enviado pelo agente. |
agent.id | não informado | ID do agente que executou o fluxo. |
agent.name | não informado | Nome do agente que executou o fluxo. |
Aniversário
Dispara uma vez no dia do aniversário de cada lead, no fuso horário da área de trabalho.
- Tipo:
trigger_birthday - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
global - Comportamento no teste:
trigger
Quando usar: Para parabenizar o lead no dia do aniversário.
Como funciona: Usa a data de nascimento do cadastro do lead. Começa uma execução por lead e por dia, mesmo sem conversa aberta; 29 de fevereiro conta no dia 28 em anos não bissextos. Disponibiliza {{lead_id}}, {{lead_name}} e {{birthday}}. Nós que dependem de uma conversa seguem sem efeito nessas execuções.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
hour | number | Não | Hora do disparo. Hora do dia (0 a 23) a partir da qual o fluxo começa para os aniversariantes do dia. Limites: mínimo 0, máximo 23, passo 1. |
Configuração padrão
{
"hour": 9
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
lead_id | não informado | ID do lead. |
lead_name | não informado | Nome do lead. |
birthday | não informado | Data do aniversário (AAAA-MM-DD). |
Ligação Recebida
Dispara quando uma ligação chega pelo tronco SIP escolhido. O fluxo atende a ligação no lugar de chamar a equipe.
- Tipo:
trigger_call_received - Categoria:
trigger - Fluxos:
voice - Escopo do gatilho:
global - Comportamento no teste:
trigger
Quando usar: Inicia um fluxo de chamada (URA) quando uma ligação chega por um tronco SIP. Só existe em fluxos do tipo voice.
Como funciona: Atende a ligação e disponibiliza {{caller_number}} e {{called_number}}. Um tronco só pode ter um fluxo de chamada ativo. Chegar em Fim desliga a ligação.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
trunk_id | select | Sim | Tronco SIP. Origem das opções: sip_trunks. |
Configuração padrão
{
"trunk_id": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
caller_number | não informado | Número de quem ligou. |
called_number | não informado | Número discado pelo cliente. |
Ligação de Campanha
Dispara quando a pessoa atende uma ligação feita por uma campanha de ligação. A campanha escolhe a linha telefônica e os leads. O fluxo é uma URA: toca áudios gravados e lê teclas, sem voz por IA e sem reconhecimento de fala.
- Tipo:
trigger_campaign_call - Categoria:
trigger - Fluxos:
voice - Escopo do gatilho:
global - Comportamento no teste:
trigger
Quando usar: Inicia um fluxo de chamada quando uma campanha de ligação chama um lead e ele atende. Só existe em fluxos do tipo voice.
Como funciona: O fluxo começa no momento em que a pessoa atende e disponibiliza {{called_number}} e {{lead_name}}. Ligações não atendidas não iniciam o fluxo. Chegar em Fim desliga a ligação. É uma URA de áudios gravados e teclas: não existe nó de voz por IA nem de reconhecimento de fala.
Configuração
Sem campos de configuração.
Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
called_number | não informado | Número chamado pela campanha. |
lead_name | não informado | Nome do lead chamado. |
Primeira Mensagem
Dispara quando o contato envia a primeira mensagem.
- Tipo:
trigger_first_message - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
conversation - Comportamento no teste:
trigger
Quando usar: Inicia o fluxo na PRIMEIRA mensagem do contato (uma vez por contato). Ideal para boas-vindas/atendimento inicial.
Como funciona: Disponibiliza {{message}} com o texto recebido e {{contact_number}} com o endereço do contato no canal (telefone no WhatsApp, id do chat no Telegram/Instagram; ausente em grupos).
Configuração
Sem campos de configuração.
Saídas
Uma única saída: a conexão vai sem label (ou com default).
Formulário respondido
Dispara quando um contato envia um formulário do WhatsApp ou um formulário de um site.
- Tipo:
trigger_form_submitted - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
global - Comportamento no teste:
trigger
Quando usar: Inicia o fluxo a cada envio de um formulário do WhatsApp ou de um formulário de um site (página publicada), por exemplo para etiquetar a conversa, criar uma negociação ou avisar a equipe.
Como funciona: Cada envio, de um formulário do WhatsApp ou de um site, inicia a sua própria execução, mesmo quando a mesma pessoa envia o formulário de novo. Disponibiliza {{form_id}}, {{form_response_id}} e {{form.<chave_do_campo>}} com o valor exibido de cada resposta (campos sensíveis mascarados). Formulários de site disparam só depois que a página é publicada com o formulário, e entregam os campos da versão publicada. Só dispara para os formulários escolhidos; sem formulário escolhido o fluxo não pode ser publicado.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
form_ids | multi-select | Sim | Formulários. Escolha ao menos um formulário do WhatsApp ou de um site: sem formulário o gatilho não dispara. Origem das opções: trigger_forms. |
Configuração padrão
{
"form_ids": []
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
form_id | não informado | ID do formulário respondido (a chave pública, nos formulários de site). |
form_response_id | não informado | ID da resposta. |
form.<campo> | não informado | Resposta de cada campo pela chave do campo; campos sensíveis chegam mascarados. |
Mensagem Recebida
Dispara a cada mensagem recebida no chat.
- Tipo:
trigger_message_received - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
conversation - Comportamento no teste:
trigger
Quando usar: Inicia o fluxo a CADA mensagem recebida. Use para um atendente que sempre responde.
Como funciona: Disponibiliza {{message}} com o texto recebido e {{contact_number}} com o endereço do contato no canal (telefone no WhatsApp, id do chat no Telegram/Instagram; ausente em grupos).
Configuração
Sem campos de configuração.
Saídas
Uma única saída: a conexão vai sem label (ou com default).
Entrou na etapa
Dispara quando uma conversa deste fluxo entra em uma etapa do funil.
- Tipo:
trigger_stage_added - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
conversation - Comportamento no teste:
trigger
Quando usar: Para agir quando a conversa muda de etapa no funil, por exemplo avisar a equipe ou mandar um template de acompanhamento.
Como funciona: Disponibiliza {{stage_id}}. Sem etapa escolhida, dispara para qualquer etapa. Vale para toda entrada em etapa: CRM, inbox, Elo, agente de IA, outro fluxo e a etapa inicial de uma conversa nova. Só dispara nas conversas pelas quais este fluxo responde: as dos números, contas e campanhas que usam este fluxo, ou conversas delegadas a ele; outro fluxo com a mesma etapa não dispara junto. Uma etapa mudada por este mesmo fluxo não o inicia de novo, e uma sequência de fluxos movendo a conversa para depois de 3 fluxos seguidos. Enquanto este fluxo está em execução na conversa, uma nova mudança de etapa não inicia outra execução. A conversa pode estar fora da janela de atendimento: comece com um template.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
stage_id | select | Não | Etapa. Vazio: qualquer etapa. Origem das opções: stages. |
Configuração padrão
{
"stage_id": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
stage_id | não informado | ID da etapa em que a conversa entrou. |
Webhook
Dispara quando um sistema externo faz um POST na URL do webhook.
- Tipo:
trigger_webhook - Categoria:
trigger - Fluxos:
messages - Escopo do gatilho:
global - Comportamento no teste:
trigger
Quando usar: Inicia o fluxo a partir de um evento externo (POST HTTP), por exemplo carrinho abandonado, pagamento pendente ou pedido pago de uma loja. Configure a URL, o segredo e o modo de autenticação no painel do nó.
Como funciona: Disponibiliza {{var.webhook.body.*}} com o corpo recebido e {{var.webhook.method}}. Iniciar em Conversa: o payload traz entry_id e entry_type, ou phone de uma conversa existente. Iniciar em Lead: o payload traz phone (o lead é encontrado ou criado, com name no cadastro novo) ou email (lead existente), e o fluxo roda mesmo sem conversa, com {{lead_id}} e {{lead_name}}. event e external_id no payload evitam execuções repetidas quando a loja reenvia o mesmo evento. Nós que dependem de uma conversa seguem sem efeito em execuções de lead.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
start_on | select | Não | Iniciar em. Conversa: a conversa existente pelo entry_id e entry_type ou pelo phone. Lead: o lead pelo phone (criado se não existir) ou pelo email, mesmo sem conversa. Valores: conversation (Conversa), lead (Lead). |
events | tags | Não | Eventos aceitos. Opcional. Com eventos, só chamadas cujo campo event esteja na lista começam o fluxo; as outras são aceitas e ignoradas. |
Configuração padrão
{
"start_on": "conversation"
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
lead_id | não informado | ID do lead. |
lead_name | não informado | Nome do lead. |
Mensagens
Enviar E-mail
Envia um e-mail usando um servidor SMTP configurado pelo usuário.
- Tipo:
action_send_email - Categoria:
messaging - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para enviar e-mail via SMTP.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
smtp_host | text | Sim | Servidor SMTP. Hostname do servidor SMTP, sem protocolo ou porta. |
smtp_port | number | Não | Porta SMTP. 587 para STARTTLS, 465 para TLS implícito ou 25 para relay sem TLS. |
smtp_security | select | Sim | Segurança SMTP. Valores: starttls (STARTTLS), implicit_tls (TLS implícito), none (Sem TLS). |
smtp_username | text | Não | Usuário SMTP. Opcional para relays sem autenticação. |
smtp_password | text | Não | Senha SMTP. Obrigatória quando usuário SMTP for informado. |
smtp_from_email | text | Sim | E-mail remetente. Endereço autorizado pelo servidor SMTP. |
smtp_from_name | text | Não | Nome do remetente. |
default_reply_to | text | Não | Responder para padrão. Reply-To padrão opcional. |
to | text | Sim | Destinatário. Aceita variáveis e múltiplos endereços separados por vírgula. |
cc | text | Não | Cc. Destinatários em cópia, separados por vírgula. |
bcc | text | Não | Bcc. Destinatários em cópia oculta, separados por vírgula. |
reply_to | text | Não | Responder para. Reply-To específico deste envio. |
subject | text | Sim | Assunto. Aceita variáveis do workflow. |
body | textarea | Sim | Conteúdo. Conteúdo HTML ou texto simples. Aceita variáveis do workflow. |
body_type | select | Não | Formato. Valores: html (HTML), text (Texto). |
timeout_seconds | number | Não | Timeout. Tempo máximo para conectar e enviar. |
Configuração padrão
{
"body": "",
"body_type": "html",
"smtp_from_email": "",
"smtp_from_name": "",
"smtp_host": "",
"smtp_password": "",
"smtp_port": 587,
"smtp_security": "starttls",
"smtp_username": "",
"subject": "",
"timeout_seconds": 30,
"to": "{{email}}"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
falha | Falha | Não |
timeout | Tempo esgotado | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
to | list | Destinatários principais usados no envio. |
cc | list | Destinatários em cópia. |
bcc | list | Destinatários em cópia oculta. |
subject | text | Assunto enviado. |
message_id | text | Message-ID gerado para o e-mail. |
server_response | text | Resposta do servidor SMTP, quando disponível. |
sent | boolean | true se o e-mail foi enviado com sucesso. |
success | boolean | Alias booleano para sucesso. |
error | text | Erro quando o envio não foi realizado. |
next_edge | text | Saída seguida pelo workflow: sucesso, falha ou timeout. |
Enviar e-mail (plataforma)
Envia um e-mail transacional pelo e-mail da plataforma, com um remetente do seu domínio verificado.
- Tipo:
action_send_platform_email - Categoria:
messaging - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para mandar um e-mail transacional ao lead (confirmação, código, aviso de pedido) pelos remetentes cadastrados em E-mail.
Como funciona: Vai para o e-mail do cadastro do lead, ou para o endereço em 'to'. Em fluxos de chamada não há cadastro do lead: preencha 'to' (por exemplo, o e-mail da equipe que retorna a ligação). O corpo é um texto ('body_mode' text) ou um design salvo ('body_mode' design). Cobra um envio do saldo antes de enviar e devolve se o envio falhar; respeita a lista de bloqueio e recusa leads bloqueados. Não exige consentimento de marketing e não leva link de descadastro. O e-mail enviado fica registrado na conversa de e-mail do lead, onde a resposta dele também chega. Assunto e texto aceitam variáveis do fluxo {{...}} e as do e-mail ({{first_name}}, {{name}}, {{email}}, {{company}}, {{field.chave}}). Saídas: 'sent' quando o provedor aceitou e 'failed' quando foi recusado; o motivo fica em reason e error.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
sender_id | select | Não | Remetente. Vazio usa o remetente padrão do workspace. Origem das opções: email_senders. |
to | text | Não | Destinatário. Vazio usa o e-mail do cadastro do lead. Aceita variáveis do fluxo. |
subject | text | Sim | Assunto. |
body_mode | select | Sim | Conteúdo. Valores: text (Texto), design (Design salvo). |
text | textarea | Quando body_mode é text | Texto. Parágrafos separados por uma linha em branco. Vale quando body_mode é text. |
design_id | select | Quando body_mode é design | Design. Origem das opções: email_designs. Vale quando body_mode é design. |
Configuração padrão
{
"body_mode": "text",
"design_id": "",
"sender_id": "",
"subject": "",
"text": "",
"to": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sent | Enviado | Sim |
failed | Falha | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
sent | boolean | true quando o provedor aceitou o e-mail. |
message_id | text | ID do e-mail na plataforma. |
provider_message_id | text | ID do e-mail no provedor. |
to | text | Endereço que recebeu o e-mail. |
repeated | boolean | true quando este passo já tinha enviado e o envio não foi repetido. |
reason | text | Código do motivo quando o envio falha. |
error | text | Descrição da recusa quando o envio falha. |
Ações
Adicionar linha na planilha
Registra uma linha em uma planilha do Google Planilhas criada no painel, com as colunas preenchidas por variáveis do fluxo.
- Tipo:
action_add_sheet_row - Categoria:
action - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para registrar pedidos, leads, agendamentos ou qualquer dado do fluxo em uma planilha do Google Planilhas.
Como funciona: A linha é validada pelos tipos das colunas e entra na fila de gravação; a saída 'sucesso' significa que ela foi aceita e será gravada em instantes, na ordem. Colunas preenchidas pelo sistema (telefone do lead, data, link da conversa) não entram no mapeamento. Uma variável sem valor leva à saída 'erro', nunca a uma célula com {{...}}. Cada coluna só aceita o tipo dela: número e dinheiro pedem um número, data uma data, data e hora uma data com hora, sim/não um booleano e escolha uma das opções da coluna. Texto (parâmetro de ferramenta do tipo string ou sem tipo, resposta do cliente, formulário) numa coluna desses tipos bloqueia a publicação; declare o parâmetro da ferramenta com o tipo da coluna (number, date, datetime, boolean ou enum com as opções da coluna) ou use um dado da conversa com esse tipo. Quando a aba tem linha única (por conversa, na aba ou no mês da aba, ou pelos valores de colunas escolhidas) e o registro já existe, nada é gravado de novo: o passo segue pela saída opcional 'ja_registrada' se ela estiver ligada, senão pela 'sucesso', com already_recorded=true e existing_row_id apontando a linha que já existia. Numa aba com linha única por conversa, um fluxo sem conversa (iniciado por um lead) segue pela 'erro' com o código google_sheet_unique_needs_conversation. Para gravar numa planilha diferente por conversa (por exemplo, uma por franquia), preencha sheet_variable com um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}; sheet_id passa a ser a aba da planilha modelo desse dado, usada só para mapear as colunas. A planilha da conversa é escolhida quando a execução começa e fica a mesma até o fim; sem ela a execução nem começa, e o passo nunca grava na planilha modelo.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
sheet_id | select | Sim | Planilha. Origem das opções: google_sheets. |
sheet_variable | sheet_variable | Não | Muda por conversa. Um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}. Vazio grava sempre na mesma planilha. |
values | sheet_columns | Sim | Colunas. O valor de cada coluna. Aceita variáveis do fluxo {{...}}. |
Configuração padrão
{
"sheet_id": "",
"values": {}
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
ja_registrada | Já registrada | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
row_id | text | ID da linha na fila de gravação. |
sheet_id | text | ID da planilha. |
sheet_title | text | Título da planilha. |
sheet_url | text | Link da planilha no Google. |
duplicate | boolean | true quando este passo já tinha registrado a linha e ela não foi repetida. |
already_recorded | boolean | true quando a aba tem linha única e este registro já existia; nada foi gravado de novo. |
existing_row_id | text | ID da linha que já registrava este registro, quando already_recorded é true. |
error | text | Descrição da recusa. |
error_code | text | Código da recusa. |
Gerenciar Etiqueta
Adiciona ou remove uma etiqueta existente da conversa atual do workflow, em qualquer canal.
- Tipo:
action_assign_label - Categoria:
action - Fluxos:
messages - Comportamento no teste:
writes_data
Quando usar: Para adicionar ou remover uma etiqueta da conversa.
Como funciona: Idempotente: se a conversa já tem a etiqueta (ao adicionar) ou não tem (ao remover), o nó segue pelo caminho de sucesso sem mudar nada.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
action | select | Não | Ação. Valores: add (Adicionar), remove (Remover). |
label_id | select | Sim | Etiqueta. Origem das opções: labels. |
Configuração padrão
{
"action": "add",
"label_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a conversa fica com a etiqueta pedida. |
changed | boolean | true quando a etiqueta foi de fato adicionada ou removida agora. |
label_id | text | ID da etiqueta. |
label_name | text | Nome da etiqueta. |
error | text | Descrição do erro quando a mudança falha. |
Atribuir ao Membro
Atribui a conversa a um membro específico do workspace.
- Tipo:
action_assign_member - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
writes_data
Quando usar: Para atribuir a conversa a um atendente específico.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
member_id | select | Sim | Membro. Origem das opções: members. |
Configuração padrão
{
"member_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a atribuição é realizada com sucesso. |
assigned_user_id | text | ID do usuário atribuído. |
assigned_user_email | text | E-mail do usuário atribuído. |
error | text | Descrição do erro quando a atribuição falha. |
Cancelar mensagens agendadas
Cancela mensagens e templates que este fluxo agendou e que ainda não foram enviados.
- Tipo:
action_cancel_scheduled_messages - Categoria:
action - Fluxos:
messagesevoice - Comportamento no teste:
writes_data
Quando usar: Quando o motivo de um agendamento deixou de existir, por exemplo quando o comprovante chegou por outro caminho.
Como funciona: Escolha uma mensagem pelo ID devolvido pelo nó Agendar mensagem ({{node.<id>.follow_up_id}}) ou todas as pendentes que este fluxo agendou. 'mine' cancela as que o fluxo agendou nesta conversa e as que esta execução agendou para um telefone com "Para"; numa execução sem conversa (aniversário, webhook em lead, ligação) só as que esta execução agendou para um telefone. Pelo ID, um template agendado para um telefone é cancelado de qualquer execução deste fluxo; uma mensagem da conversa, só a partir da mesma conversa. Uma mensagem já enviada não é cancelada.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
scope | select | Sim | O que cancelar. Valores: mine (Todas que este fluxo agendou aqui), id (Uma mensagem pelo ID). |
follow_up_id | text | Quando scope é id | ID da mensagem agendada. Vale quando scope é id. |
Configuração padrão
{
"follow_up_id": "",
"scope": "mine"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Cancelada | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
cancelled | number | Quantas mensagens foram canceladas. |
cancelled_ids | list | IDs das mensagens canceladas. |
error | text | Descrição da recusa. |
error_code | text | Código da recusa. |
Verificar Disponibilidade
Consulta o Google Calendar do workspace e retorna horários livres no período informado.
- Tipo:
action_check_calendar_availability - Categoria:
action - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para consultar horários livres no Google Calendar, inclusive durante uma ligação (por exemplo, para o dia que quem ligou digitou em Aguardar Tecla com o tipo data).
Como funciona: date_from/date_to aceitam YYYY-MM-DD (dia de expediente inteiro) ou data/hora ISO/RFC3339. date_to vazio consulta até o fim do expediente. Datas iguais sem hora consultam um único dia. Use timezone do workspace. Não invente disponibilidade; só confirme após success=true.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
date_from | text | Sim | Data/hora início. |
date_to | text | Não | Data/hora fim. |
timezone | text | Sim | Timezone. |
slot_duration | number | Não | Duração do slot (minutos). |
working_start | text | Não | Início do expediente. |
working_end | text | Não | Fim do expediente. |
work_days | select | Não | Dias de trabalho. Valores: weekdays (Segunda a Sexta), weekdays_saturday (Segunda a Sábado), all_week (Todos os dias). |
Configuração padrão
{
"date_from": "{{var.date_from}}",
"date_to": "",
"slot_duration": 30,
"timezone": "America/Sao_Paulo",
"work_days": "weekdays",
"working_end": "18:00",
"working_start": "08:00"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a consulta foi bem-sucedida. |
available_slots | text | Lista de horários livres formatados. |
available_slots_json | text | JSON array com objetos {start, end} dos slots livres. |
busy_count | number | Quantidade de eventos ocupados encontrados. |
date_from | date | Início do período consultado (RFC3339). |
date_to | date | Fim do período consultado (RFC3339). |
timezone | text | Timezone efetivamente usada. |
calendar_email | text | Conta Google conectada ao workspace. |
error | text | Descrição do erro quando a consulta falha. |
Consentimento
Registra ou retira o consentimento do lead da conversa para receber mensagens.
- Tipo:
action_consent - Categoria:
action - Fluxos:
messages - Comportamento no teste:
writes_data
Quando usar: Para gravar no lead da conversa a vontade dele sobre receber mensagens: 'registrar' quando ele aceitou, 'retirar' quando pediu para parar.
Como funciona: Modo 'registrar' só é aceito depois da resposta do lead em todos os caminhos (saída 'replied' de wait_for_reply, uma opção de action_send_interactive ou a saída 'true' de uma condição sobre {{selected_option_id}} ou {{selected_option_title}}) e cita a mensagem do lead que acordou o fluxo, inclusive o toque em um botão de template. Modo 'retirar' vale em qualquer ponto: cita a mensagem que disparou o fluxo ou, sem mensagem, grava a nota do nó com a execução. Depois de retirar, os envios do fluxo para este lead são recusados. Qualquer recusa ou falha interrompe a execução com o motivo; o fluxo fica registrado como autor.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
mode | select | Sim | Ação. Valores: registrar (Registrar consentimento), retirar (Retirar consentimento (parar de receber)). |
purpose | text | Não | Finalidade. Opcional. Para que o lead aceitou receber mensagens. Aceita variáveis. Vale quando mode é registrar. |
note | text | Não | Nota. Opcional. Gravada como prova quando a execução não tem uma mensagem do lead. Aceita variáveis. Vale quando mode é retirar. |
Configuração padrão
{
"mode": "",
"note": "",
"purpose": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Registrado | Sim |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
lead_id | text | ID do lead da conversa. |
changed | boolean | true quando a vontade do lead mudou agora; false quando já estava registrada. |
event_id | text | ID do evento na linha do tempo do lead, quando mudou. |
Criar evento na agenda
Cria um evento no Google Calendar do workspace. Gerar um link do Google Meet para o evento é opcional.
- Tipo:
action_create_calendar_event - Categoria:
action - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para criar um evento no Google Calendar (visita, consulta, chamada ou qualquer compromisso), inclusive durante uma ligação, com o horário confirmado por quem ligou.
Como funciona: Requer uma conexão ativa com o Google Calendar do workspace.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
title | text | Sim | Título. |
description | textarea | Não | Descrição. |
location | text | Não | Local. |
start_time | text | Sim | Início. |
end_time | text | Não | Fim. |
duration | number | Não | Duração (minutos). |
timezone | text | Sim | Timezone. |
attendees | textarea | Não | Convidados. |
create_google_meet | select | Não | Criar link do Google Meet (opcional). Valores: true (Sim), false (Não). |
send_updates | select | Não | Enviar convites. Valores: all (Todos), externalOnly (Somente externos), none (Não enviar). |
Configuração padrão
{
"attendees": "",
"create_google_meet": "true",
"description": "Evento agendado via ",
"duration": 30,
"end_time": "",
"location": "",
"send_updates": "all",
"start_time": "{{var.start_time}}",
"timezone": "America/Sao_Paulo",
"title": "Evento agendado"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando o evento é criado com sucesso. |
title | text | Título final enviado ao Google Calendar. |
google_event_id | text | ID do evento no Google Calendar. |
meeting_link | text | Link do Google Meet do evento, vazio quando o Meet não foi pedido. |
start_time | date | Início do evento em RFC3339. |
end_time | date | Fim do evento em RFC3339. |
timezone | text | Timezone efetivamente usada. |
attendees | list | Lista final de participantes convidados. |
calendar_email | text | Conta Google conectada ao workspace. |
error | text | Descrição do erro quando a criação falha. |
Exportar mensagens para planilha
Grava na planilha uma linha por mensagem da conversa, desde a última exportação desta conversa para a mesma planilha.
- Tipo:
action_export_messages_sheet - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
external_call
Quando usar: Para registrar a linha do tempo de um cliente numa planilha do Google Planilhas, por exemplo quando a conversa entra na etapa de pagamento recebido.
Como funciona: Lê as mensagens novas da conversa desde a última exportação para esta planilha e grava todas de uma vez, uma linha por mensagem, na ordem em que aconteceram. As colunas com fonte de mensagem (data, quem enviou, sentido, texto, link da mídia) mudam a cada linha; as do lead e da conversa se repetem em todas. Repetir o passo nunca duplica linhas. A saída 'erro' recebe recusas da planilha, e nesse caso nada é marcado como exportado. Para gravar numa planilha diferente por conversa (por exemplo, uma por franquia), preencha sheet_variable com um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}; sheet_id passa a ser a aba da planilha modelo desse dado, usada só para mapear as colunas. A planilha da conversa é escolhida quando a execução começa e fica a mesma até o fim; sem ela a execução nem começa, e o passo nunca grava na planilha modelo.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
sheet_id | select | Sim | Planilha. Origem das opções: google_sheets. |
sheet_variable | sheet_variable | Não | Muda por conversa. Um dado da conversa do tipo Planilha, como {{campvars.planilha_franquia}}. Vazio grava sempre na mesma planilha. |
values | sheet_columns | Não | Colunas. O valor das colunas preenchidas pelo fluxo, igual em todas as linhas desta exportação. Aceita variáveis do fluxo {{...}}. |
Configuração padrão
{
"sheet_id": "",
"values": {}
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
exported | number | Quantas mensagens novas entraram na fila de gravação. |
duplicates | number | Mensagens que já estavam na planilha e não foram repetidas. |
has_more | boolean | true quando há mais mensagens do que cabem em uma exportação; a próxima exportação continua delas. |
sheet_id | text | ID da planilha. |
sheet_title | text | Título da planilha. |
sheet_url | text | Link da planilha no Google. |
error | text | Descrição da recusa. |
error_code | text | Código da recusa. |
Finalizar Conversa
Encerra a conversa atual no CRM (status Finalizada). Reabre se o cliente mandar mensagem de novo.
- Tipo:
action_finish_conversation - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
writes_data
Quando usar: Quando o fluxo concluiu o atendimento e a conversa deve sair do conjunto aberto (ex.: após despedida, resolução, ou fim de automação).
Como funciona: Chama o mesmo serviço de status que humanos e a ferramenta finish_conversation da IA. Origem: system · motivo: workflow. Idempotente se já estiver finalizada. Não encerra o run do workflow, conecte a saída sucesso a um nó Fim se quiser terminar o fluxo.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
outcome_code | select | Não | Desfecho. O desfecho registrado no encerramento, da lista do workspace. Obrigatório quando o workspace exige um desfecho; sem ele o nó sai pela saída erro. Origem das opções: outcomes. |
note | text | Não | Nota (opcional). Apenas registro no output do nó; o motivo de sistema permanece workflow. |
Configuração padrão
{
"note": "",
"outcome_code": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a conversa foi finalizada (ou já estava). |
entry_id | text | ID da entrada finalizada. |
entry_type | text | Tipo da entrada (whatsapp, unofficial_whatsapp, instagram, telegram ou support). |
close_source | text | Proveniência do encerramento (system). |
close_reason | text | Motivo (workflow). |
close_outcome | text | Código do desfecho registrado, quando houver. |
error | text | Descrição do erro quando falha. |
Requisição HTTP
Faz uma requisição HTTP para um serviço externo.
- Tipo:
action_http_request - Categoria:
action - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para chamar uma API externa (ex.: ViaCEP, CRM, etc.).
Como funciona: Monte url, headers e corpo com variáveis (ex.: url com {{node.<id>.<arg>}}). Se a resposta for JSON, CADA campo do corpo torna-se uma saída de dados deste nó, acessível adiante via {{node.<id>.<campo>}} (ex.: {{node.n4.logradouro}}). Credenciais (senha, token, chave de API) ficam nos segredos do workspace: use {{secret.<nome>}} na url, nos headers, no corpo ou no token; o valor só é lido ao montar a requisição e nunca vai para o estado nem para os logs.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
method | select | Sim | Método. Valores: GET (GET), POST (POST), PUT (PUT), PATCH (PATCH), DELETE (DELETE), HEAD (HEAD), OPTIONS (OPTIONS). |
url | text | Sim | URL. |
headers | keyvalue | Não | Headers. Cabeçalhos HTTP em formato chave-valor. |
query_params | keyvalue | Não | Parâmetros de Query. Parâmetros adicionados à URL (?key=value). |
body | textarea | Não | Corpo da Requisição. Corpo JSON da requisição (suporta variáveis). |
auth_type | select | Não | Autenticação. Valores: vazio (Nenhuma), bearer (Bearer Token), basic (Basic Auth), api_key (API Key (Header)). |
auth_token | text | Não | Token / Senha. Bearer token, senha do Basic Auth, ou valor da API Key. |
auth_user | text | Não | Usuário (Basic Auth). Apenas para Basic Auth. |
auth_key_name | text | Não | Nome do Header (API Key). Nome do header para API Key. |
timeout_seconds | number | Não | Timeout (segundos). Tempo máximo de espera pela resposta, até 30 segundos. |
capture_variable | text | Não | Salvar resposta em variável. Salva o corpo da resposta em uma variável para uso em nós posteriores. |
capture_label | text | Não | Nome amigável da resposta. Como a resposta aparece nas listas e nos campos. |
Configuração padrão
{
"headers": {},
"method": "GET",
"url": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
falha | Falha | Não |
timeout | Tempo esgotado | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
status_code | number | Código HTTP (ex: 200, 404). |
body | text | Corpo bruto da resposta (string). |
success | boolean | true se status < 400. |
* | não informado | Se a resposta for JSON, cada campo do objeto é extraído automaticamente. Ex: se o body for {"bairro":"Sé"}, use {{last.bairro}}. |
Gerenciar Negociação
Cria ou atualiza negociações da conversa: valor, etapa, ganho ou perda.
- Tipo:
action_manage_opportunity - Categoria:
action - Fluxos:
messages - Comportamento no teste:
writes_data
Quando usar: Para registrar a venda da conversa no funil de negociações, por exemplo depois que um agente confirma o fechamento.
Como funciona: Sem ID da negociação, o nó age na única negociação aberta da conversa neste funil; com mais de uma aberta, segue pela saída Erro. Criar nova negociação sempre abre outra, para quando a conversa trata mais de um contrato. Mover, atualizar valor e marcar como perdido nunca criam negociação. O fluxo fica registrado como responsável e autor. Ganho exige valor; perdido exige motivo.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
pipeline_id | select | Sim | Funil de negociações. O funil de negociações onde fica a negociação desta conversa. Origem das opções: opportunity_pipelines. |
action | select | Sim | Ação. Valores: create (Criar ou atualizar), create_new (Criar nova negociação), update_value (Atualizar valor), move (Mover de etapa), win (Marcar como ganho), lose (Marcar como perdido). |
opportunity_id | text | Não | ID da negociação. Opcional. Vazio: a única negociação aberta da conversa neste funil. Com mais de uma aberta, informe o ID vindo de um passo anterior. Vale quando action é create, update_value, move, win ou lose. |
stage_id | select | Quando action é move | Etapa da negociação. Etapa onde a negociação fica. Obrigatória para mover. Origem das opções: opportunity_stages. Vale quando action é create, create_new ou move. |
title | text | Não | Título. Título usado quando a negociação é criada. Vale quando action é create ou create_new. |
value | text | Quando action é update_value | Valor. Número com ponto decimal, ex.: 1500.50. Aceita variáveis. Ganho exige valor quando a negociação ainda não tem. Vale quando action é create, create_new, update_value ou win. |
lost_reason | text | Quando action é lose | Motivo da perda. Aceita variáveis. Vale quando action é lose. |
Configuração padrão
{
"action": "create",
"pipeline_id": "",
"title": "Negociação da conversa",
"value": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a negociação foi registrada. |
created | boolean | true quando a negociação foi criada agora. |
opportunity_id | text | ID da negociação. |
status | text | Situação da negociação: open, won ou lost. |
stage_id | text | ID da etapa da negociação. |
title | text | Título da negociação. |
value_cents | number | Valor em centavos. |
value | number | Valor na unidade da moeda. |
currency | text | Moeda da negociação. |
error | text | Motivo quando a negociação não pôde ser registrada. |
Mover Etapa
Move a conversa para a etapa escolhida. Uma conversa de outro funil vai para o funil dessa etapa.
- Tipo:
action_move_stage - Categoria:
action - Fluxos:
messages - Comportamento no teste:
writes_data
Quando usar: Para avançar a conversa no funil conforme o fluxo (ex.: qualificado, proposta enviada, ganho) ou para levá-la a uma etapa de outro funil de conversas.
Como funciona: A conversa vai exatamente para a etapa escolhida. Se ela está em outro funil, muda para o funil dessa etapa, como quem usa "mover para funil" no CRM; uma conversa ainda sem etapa entra no funil da etapa escolhida. Já estando na etapa, não muda nada. Só etapas de funis de conversa servem; etapas de funis de negociações são recusadas. pipeline_changed diz se a conversa trocou de funil, from_pipeline_id e from_pipeline_name dizem de onde ela saiu.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
stage_id | select | Sim | Etapa. A etapa para onde a conversa vai. Uma conversa de outro funil muda para o funil desta etapa. Origem das opções: stages. |
Configuração padrão
{
"stage_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a conversa está na etapa escolhida. |
changed | boolean | true quando a conversa mudou de etapa (false se já estava nela). |
stage_id | text | ID da etapa escolhida. |
stage_name | text | Nome da etapa escolhida. |
pipeline_id | text | ID do funil da etapa escolhida. |
pipeline_name | text | Nome do funil da etapa escolhida. |
from_stage_id | text | ID da etapa anterior (vazio se não havia). |
from_stage_name | text | Nome da etapa anterior. |
from_pipeline_id | text | ID do funil onde a conversa estava (vazio se não havia etapa). |
from_pipeline_name | text | Nome do funil onde a conversa estava. |
pipeline_changed | boolean | true quando a conversa saiu de outro funil para o funil da etapa escolhida. |
error | text | Descrição do erro quando a conversa não pôde ser movida. |
error_code | text | Código da recusa quando a conversa não pôde ser movida. |
Tocar Áudio
Toca um áudio da biblioteca de mídias para quem está na ligação.
- Tipo:
action_play_audio - Categoria:
action - Fluxos:
voice - Comportamento no teste:
voice_only
Quando usar: Para falar com quem ligou: saudação, menu de opções ou aviso. Só existe em fluxos de chamada.
Como funciona: Toca o áudio escolhido (media_id, use find_resource medias com um arquivo de áudio). Com 'interruptible' (padrão), uma tecla pressionada corta o áudio e fica guardada para o próximo wait_dtmf, como numa URA.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
media_id | select | Sim | Áudio. Arquivo de áudio da biblioteca de mídias. Origem das opções: medias. |
interruptible | boolean | Não | Tecla interrompe o áudio. Quem ligou pode escolher a opção sem ouvir o áudio até o fim. |
Configuração padrão
{
"interruptible": true,
"media_id": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
interrupted | boolean | Verdadeiro quando uma tecla cortou o áudio. |
Responder ao agente
Devolve um resultado ao agente de IA que executou este fluxo.
- Tipo:
action_reply_to_agent - Categoria:
action - Fluxos:
messages - Comportamento no teste:
pure
Quando usar: Em fluxos com o gatilho Chamado por agente IA, para contar ao agente o que aconteceu (por exemplo status e mensagem).
Como funciona: Interpola cada campo, mascara dados sensíveis (tokens, senhas, CPF) e grava o mapa como resultado da execução; a última gravação vale. O agente vê só esses campos, nunca o estado interno do fluxo. Segue pela saída padrão e disponibiliza os mesmos campos em {{last.<campo>}}.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
fields | agent_reply_fields | Não | Campos devolvidos ao agente. Lista de chave e valor; o valor aceita variáveis como {{input.cpf}} ou {{node.<id>.<campo>}}. |
Configuração padrão
{
"fields": []
}Saídas
Encerra o caminho e não tem saídas.
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
<campo> | não informado | Cada campo devolvido ao agente, já mascarado. |
Reagendar evento na agenda
Muda a data/horário de um evento já existente no Google Calendar, mantendo os participantes e o link do Google Meet, quando houver.
- Tipo:
action_reschedule_calendar_event - Categoria:
action - Fluxos:
messages - Comportamento no teste:
external_call
Quando usar: Para mudar a data/horário de um evento existente na agenda (reagendamento).
Como funciona: Requer o ID do evento (google_event_id do nó Criar evento na agenda) e uma conexão ativa com o Google Calendar.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
event_id | text | Sim | ID do evento. |
start_time | text | Sim | Novo início. |
end_time | text | Não | Novo fim. |
duration | number | Não | Duração (minutos). |
timezone | text | Sim | Timezone. |
send_updates | select | Não | Notificar participantes. Valores: all (Todos), externalOnly (Somente externos), none (Não notificar). |
Configuração padrão
{
"duration": 0,
"end_time": "",
"event_id": "{{var.google_event_id}}",
"send_updates": "all",
"start_time": "{{var.start_time}}",
"timezone": "America/Sao_Paulo"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando o evento é reagendado com sucesso. |
google_event_id | text | ID do evento no Google Calendar. |
meeting_link | text | Link do Google Meet do evento, vazio quando o evento não tem Meet. |
start_time | date | Novo início em RFC3339. |
end_time | date | Novo fim em RFC3339. |
timezone | text | Timezone efetivamente usada. |
error | text | Descrição do erro quando o reagendamento falha. |
Agendar mensagem
Agenda uma mensagem ou um template do WhatsApp para mais tarde, como cobrar um comprovante. Aparece nas mensagens agendadas da conversa que vai recebê-la.
- Tipo:
action_schedule_message - Categoria:
action - Fluxos:
messagesevoice - Precisa de conversa: sim
- Comportamento no teste:
writes_data
Quando usar: Para lembrar o contato de algo mais tarde (um comprovante, um documento, uma resposta) sem prender o fluxo esperando. Com message_kind 'template' a mensagem agendada é o próprio template aprovado; com "Para" (campo 'to') ele vai para qualquer telefone, de qualquer fluxo: aniversário, webhook em lead, formulário ou ligação.
Como funciona: message_kind 'text' (o padrão) agenda o texto na conversa do fluxo; ao agendar, o passo confere se o horário cai dentro da janela de 24 horas do WhatsApp oficial (que vai até 24 horas depois da última mensagem do contato): dentro, agenda o texto; fora, agenda o template de reserva (fallback_template_id com fallback_params) e, sem ele, vai para a saída 'erro'. Para lembrar o contato em qualquer horário, use um único passo com message_kind 'text' e fallback_template_id; não divida o fluxo por horário (com código ou condição) para escolher entre texto e template: o passo já escolhe pela janela real, que conta a partir da última mensagem do contato e não de agora. message_kind 'template' agenda o template escolhido em template_id com template_params (um valor por variável do template, na ordem: primeiro a variável do cabeçalho de texto, se houver, depois as do corpo; um cabeçalho de imagem, vídeo ou documento usa a mídia do próprio template e não leva valor); não precisa de texto, vale dentro ou fora da janela, é cobrado no envio e o horário vai até 30 dias. Sem "Para" o template vai ao contato da conversa do WhatsApp oficial; em fluxos de chamada, sem "Para", vai a quem ligou. Com "Para" ou em fluxos de chamada, business_phone_id (o número do WhatsApp que envia) é obrigatório; a mensagem fica na conversa desse telefone com esse número, que é aberta se ainda não existir, e no horário sai pelo mesmo envio do botão Enviar template do CRM (saldo, limite mensal, opt-out, bloqueio e proteção contra spam). 'to' aceita um número fixo ou um dado do fluxo, como o telefone do lead; um dado sem valor ou um telefone inválido vai para a saída 'erro'. Por padrão a mensagem é cancelada se o contato responder antes, na conversa que vai recebê-la. Ao agendar e de novo antes de enviar, o sistema confere se uma pessoa assumiu a conversa que vai receber a mensagem (a do fluxo ou, com "Para", a desse telefone): ao agendar, vai para a saída 'erro' com follow_up_not_allowed; no horário, a mensagem não é enviada e fica cancelada. Cada conversa guarda no máximo 3 mensagens pendentes agendadas por automação.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
message_kind | choice_cards | Não | O que agendar. Valores: text (Mensagem escrita), template (Sempre um template). |
text | textarea | Quando message_kind é vazio ou text | Mensagem. Vale quando message_kind é vazio ou text. |
fallback_template_id | select | Não | Template de reserva. Se a janela de 24h estiver fechada no horário, envia este template. Só no WhatsApp oficial. Origem das opções: whatsapp_templates. Vale quando message_kind é vazio ou text. |
fallback_params | tags | Não | Valores do template de reserva. As variáveis do template de reserva, na ordem: primeiro a do cabeçalho de texto, se houver, depois as do corpo. Aceita dados do fluxo. Vale quando message_kind é vazio ou text. |
to | text | Não | Para. Telefone que recebe o template. Aceita um dado do fluxo ou um número fixo. Vale quando message_kind é template. |
business_phone_id | select | Quando to está preenchido | Número do WhatsApp. Obrigatório quando Para está preenchido e em fluxos de chamada. Origem das opções: business_phones. Vale quando message_kind é template. |
template_id | select | Quando message_kind é template | Template WhatsApp. Origem das opções: whatsapp_templates. Vale quando message_kind é template. |
template_params | tags | Não | Valores do template. As variáveis do template, na ordem: primeiro a do cabeçalho de texto, se houver, depois as do corpo. Aceita dados do fluxo. Vale quando message_kind é template. |
when_mode | select | Sim | Quando. Valores: in (Daqui a um tempo), day (Daqui a alguns dias, num horário), date (Numa data e horário). |
delay_amount | number | Quando when_mode é in | Quanto tempo. Número inteiro maior que zero, ou uma variável. Vale quando when_mode é in. |
delay_unit | select | Quando when_mode é in | Unidade. Ou uma variável com minutes, hours ou days. Valores: minutes (Minutos), hours (Horas), days (Dias). Vale quando when_mode é in. |
days_from_today | number | Quando when_mode é day | Dias a partir de hoje. 0 hoje, 1 amanhã, ou uma variável. Vale quando when_mode é day. |
date | text | Quando when_mode é date | Data. Vale quando when_mode é date. |
time | text | Quando when_mode é day ou date | Horário. HH:MM no fuso do workspace, ou uma variável. Vale quando when_mode é day ou date. |
cancel_on_reply | boolean | Não | Cancelar se o contato responder. Ligado: qualquer mensagem do contato antes do horário, na conversa que vai receber a mensagem, cancela o envio. |
Configuração padrão
{
"business_phone_id": "",
"cancel_on_reply": true,
"date": "",
"days_from_today": 1,
"delay_amount": 4,
"delay_unit": "hours",
"fallback_template_id": "",
"message_kind": "text",
"template_id": "",
"text": "",
"time": "10:00",
"to": "",
"when_mode": "in"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Agendada | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
follow_up_id | text | ID da mensagem agendada, para cancelar depois. |
scheduled_at | text | Horário do envio em UTC (ISO 8601). |
scheduled_for | text | Horário do envio no fuso do workspace (DD/MM/AAAA HH:MM). |
kind | text | text ou template. |
error | text | Descrição da recusa. |
error_code | text | Código da recusa. |
error_field | text | Campo do horário que foi recusado. |
error_field_label | text | Nome do campo do horário que foi recusado. |
Enviar formulário
Envia um formulário do WhatsApp e espera o contato responder. Só no WhatsApp oficial, com a janela de 24 horas aberta.
- Tipo:
action_send_form - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
waits
Quando usar: Para coletar vários dados de uma vez (cadastro, pesquisa, agendamento) com um formulário publicado do WhatsApp.
Como funciona: O nó PAUSA até o contato enviar o formulário. Respostas comuns de texto NÃO avançam o nó. Saídas: 'completed' (formulário enviado pelo contato), 'no_reply' (sem resposta até o timeout), 'send_failed' (não foi possível enviar: janela de 24 horas fechada sem template reserva, canal que não é WhatsApp oficial, formulário não publicado no número). Com a janela fechada, o template reserva (um template aprovado com botão deste formulário) é enviado no lugar e o nó continua esperando a resposta. Depois de 'completed' o fluxo tem {{form_response_id}} e {{form.<chave_do_campo>}} com o valor exibido de cada resposta (campos sensíveis mascarados).
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
form_id | select | Sim | Formulário. Origem das opções: whatsapp_forms. |
header | text | Não | Cabeçalho. |
body | textarea | Sim | Texto da mensagem. |
footer | text | Não | Rodapé. |
cta | text | Sim | Texto do botão. |
timeout_seconds | number | Não | Timeout (segundos). |
fallback_template_id | select | Não | Template reserva. Enviado quando a janela de 24 horas está fechada. Opcional. Origem das opções: whatsapp_templates. |
fallback_params | keyvalue | Não | Parâmetros do template reserva. |
Configuração padrão
{
"body": "",
"cta": "",
"fallback_params": {},
"fallback_template_id": "",
"footer": "",
"form_id": "",
"header": "",
"timeout_seconds": 300
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
completed | Respondeu | Sim |
no_reply | Não respondeu | Não |
send_failed | Falha no envio | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
sent | boolean | true se o formulário foi enviado. |
form_id | text | ID do formulário enviado. |
send_id | text | ID do envio do formulário. |
message_id | text | ID da mensagem enviada. |
reason | text | Motivo quando o envio falha. |
fallback_template_id | text | ID do template reserva, quando ele foi enviado no lugar do formulário. |
form_response_id | text | ID da resposta (após a resposta). |
form.<campo> | não informado | Resposta de cada campo pela chave do campo (após a resposta). |
Enviar Opções
Envia uma escolha única (botões ou lista) e ramifica o fluxo conforme a opção escolhida pelo contato. Funciona no WhatsApp, Instagram e Telegram, cada canal exibe as opções no formato que suporta.
- Tipo:
action_send_interactive - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
waits
Quando usar: Para pedir uma escolha ÚNICA e seguir um caminho diferente por opção. Use 'buttons' para poucas opções e 'list' para muitas; cada canal renderiza no formato nativo dele.
Como funciona: Saídas DINÂMICAS: cada opção (botão ou linha da lista) vira uma saída com o MESMO id da opção. Preencha as opções ANTES de conectar. Ao conectar qualquer saída de opção (ou 'no_match'/'no_reply'/'send_failed'), o nó PAUSA aguardando a resposta e ramifica pelo id escolhido. Saídas opcionais: 'no_match' (respondeu algo fora das opções), 'no_reply' (não respondeu até o timeout), 'send_failed' (falha no envio). Sem nenhuma saída de opção conectada, comporta-se como envio simples e segue adiante (compatibilidade). LIMITES POR CANAL: WhatsApp exibe 3 botões ou 10 itens de lista (com descrição por item); Instagram exibe até 13 opções com rótulo de 20 caracteres e SEM descrição; Telegram exibe as opções em teclado inline, sem limite prático de quantidade nem de rótulo, mas o id da opção não pode passar de 64 bytes. Opções além do limite de um canal simplesmente não aparecem nele, o editor mostra quais. FORMATO EXATO das opções, com as chaves escritas exatamente assim: buttons é uma string JSON com a lista de {"Type":"reply","ID":"...","Title":"...","CopyCode":""}; sections é uma string JSON com a lista de {"title":"...","rows":[{"id":"...","title":"...","description":"..."}]} (minúsculas).
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
interactive_type | select | Não | Formato. Valores: buttons (Botões (poucas opções)), list (Lista (muitas opções)). |
header_type | select | Não | Tipo de Cabeçalho. Valores: vazio (Nenhum), text (Texto), image (Imagem), video (Vídeo). |
header_text | text | Não | Texto do Cabeçalho. |
header_media_url | text | Não | URL da Mídia. |
body | textarea | Sim | Texto da mensagem. |
footer | text | Não | Rodapé. |
buttons | buttons | Não | Botões. |
list_button | text | Não | Rótulo do menu (lista). |
sections | list_sections | Não | Opções da lista. |
timeout_seconds | number | Não | Timeout (segundos). |
Configuração padrão
{
"body": "Seu texto aqui",
"buttons": "[]",
"footer": "",
"header_media_url": "",
"header_text": "",
"header_type": "",
"interactive_type": "buttons",
"list_button": "Ver opções",
"sections": "[]",
"timeout_seconds": 300
}Saídas
As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
message_id | text | ID da mensagem enviada. |
sent | boolean | true se enviado com sucesso. |
selected_option_id | text | id da opção escolhida (após a resposta). |
selected_option_title | text | texto da opção escolhida (após a resposta). |
Enviar Mídia
Envia uma imagem, vídeo, áudio ou documento ao contato.
- Tipo:
action_send_media - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
sends_message
Quando usar: Para enviar imagem, vídeo, áudio ou documento.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
media_id | select | Não | Mídia Salva. Origem das opções: medias. |
media_url | text | Não | URL da Mídia. |
caption | textarea | Não | Legenda. |
Configuração padrão
{
"caption": "",
"media_id": "",
"media_url": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
media_url | text | URL da mídia enviada. |
media_type | text | Tipo da mídia (image, video, audio, document). |
caption | text | Legenda enviada. |
message_id | text | ID da mensagem enviada. |
sent | boolean | true se enviado com sucesso. |
Enviar pesquisa
Envia agora uma pesquisa de satisfação (CSAT ou NPS) para o contato da conversa.
- Tipo:
action_send_survey - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
writes_data
Quando usar: Para pedir a nota do atendimento num ponto do fluxo, sem esperar a conversa ser encerrada.
Como funciona: Usa a pesquisa escolhida e as mesmas regras do envio automático: no WhatsApp oficial só com a janela de 24 horas aberta, e no máximo uma pesquisa por contato a cada 24 horas. Saídas: 'sent' (enviada), 'cooling_down' (o contato já recebeu uma pesquisa nas últimas 24 horas), 'failed' (pesquisa removida, janela fechada, canal sem pesquisa ou envio recusado; o motivo fica em {{node.<id>.reason}}). A resposta do contato é registrada na pesquisa, não no fluxo.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
survey_id | select | Sim | Pesquisa. Origem das opções: surveys. |
Configuração padrão
{
"survey_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sent | Enviada | Sim |
cooling_down | Já recebeu hoje | Não |
failed | Não enviada | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
sent | boolean | true quando a pesquisa foi enviada. |
survey_id | text | ID da pesquisa. |
send_id | text | ID do envio da pesquisa. |
message_id | text | ID da mensagem enviada. |
reason | text | Motivo quando a pesquisa não é enviada. |
error | text | Descrição da recusa. |
Enviar Template
Envia um template pré-aprovado do WhatsApp para o contato da conversa ou, com "Para" preenchido, para qualquer número. Selecione o número do WhatsApp emissor.
- Tipo:
action_send_template - Categoria:
action - Fluxos:
messagesevoice - Precisa de conversa: sim
- Comportamento no teste:
sends_message
Quando usar: Para enviar um template de WhatsApp pré-aprovado (necessário fora da janela de 24h). Sem "Para", envia ao contato da conversa do WhatsApp oficial. Com "Para" (campo 'to'), envia a qualquer telefone, de qualquer fluxo: conversa de Instagram ou e-mail, webhook, formulário, aniversário ou ligação. Em fluxos de chamada, sem "Para", envia ao número de quem ligou.
Como funciona: Com "Para" ou em fluxos de chamada, o envio é o mesmo do botão Enviar template do CRM: abre ou reaproveita a conversa desse telefone no número escolhido em "Número do WhatsApp" (obrigatório nesses casos), cobra o saldo pelo preço da categoria, estorna se o WhatsApp recusar, respeita o limite mensal de envios, opt-out, bloqueio e a proteção contra spam, e conta como envio avulso no resumo de campanhas. 'to' aceita uma variável ({{caller_number}}, um dado da conversa, de planilha ou de HTTP) ou um número fixo; o telefone é validado no envio. Se o envio for recusado (telefone inválido, opt-out, bloqueio, sem saldo, limite mensal, template não aprovado, conversa já aberta), o passo falha com o código do motivo e o fluxo para com alerta, sem nova tentativa.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
to | text | Não | Para. Telefone que recebe o template. Aceita variáveis ou um número fixo. |
business_phone_id | select | Quando to está preenchido | Número do WhatsApp. Origem das opções: business_phones. |
template_id | select | Sim | Template WhatsApp. Origem das opções: whatsapp_templates. |
params | keyvalue | Não | Parâmetros do Template. |
Configuração padrão
{
"business_phone_id": "",
"params": {},
"template_id": "",
"to": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
business_phone_id | text | ID do número do WhatsApp usado no envio. |
template_id | text | ID do template enviado. |
template_name | text | Nome do template enviado. |
message_id | text | ID da mensagem enviada. |
sent | boolean | true se enviado com sucesso. |
Enviar Texto
Envia uma mensagem de texto ao contato.
- Tipo:
action_send_text - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
sends_message
Quando usar: Para enviar uma mensagem de texto ao contato (texto fixo ou montado com variáveis). Útil para enviar a saída de um nó anterior, ou em canais onde o agente não envia sozinho.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
text | textarea | Sim | Texto da Mensagem. |
Configuração padrão
{
"text": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
text | text | Texto enviado. |
sent | boolean | true se enviado com sucesso. |
message_id | text | ID da mensagem no canal. |
Transferir conversa
Passa a conversa a uma pessoa pela roleta do workspace (a mesma regra de distribuição da primeira mensagem) e pausa a automação. O departamento é opcional: vazio, usa o da conversa.
- Tipo:
action_transfer_department - Categoria:
action - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
writes_data
Quando usar: Para passar a conversa a uma pessoa pela roleta, do departamento da conversa ou de um departamento escolhido.
Como funciona: Usa o modo da roleta do workspace (online ou última vez online) e só entrega a quem pode receber conversas. Sem ninguém disponível, a conversa vai para a fila da equipe (queued = true). Pausa a automação desta conversa.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
department_id | select | Não | Departamento. Vazio: usa o departamento da própria conversa. Origem das opções: departments. |
Configuração padrão
{
"department_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando a conversa foi entregue a alguém ou à fila da equipe. |
queued | boolean | true quando ninguém estava disponível e a conversa foi para a fila da equipe. |
department_id | text | ID do departamento escolhido (vazio: departamento da conversa). |
department_name | text | Nome do departamento escolhido. |
assigned_user_id | text | ID de quem recebeu a conversa (vazio na fila da equipe). |
assigned_user_email | text | E-mail de quem recebeu a conversa. |
error | text | Descrição do erro quando a transferência falha. |
Transferir para Fila
Coloca quem ligou na fila com música de espera até um atendente livre atender.
- Tipo:
action_transfer_to_queue - Categoria:
action - Fluxos:
voice - Comportamento no teste:
voice_only
Quando usar: Para passar a ligação a uma pessoa: depois do menu, na opção 'falar com atendente'. Só existe em fluxos de chamada.
Como funciona: Escolha a fila (queue_id, use find_resource call_queues). Quem ligou ouve a música de espera da fila e é entregue a quem está livre há mais tempo (ou à estratégia da fila). 'notes' chega ao atendente antes de atender e aceita variáveis como {{var.x}}. Quando alguém atende, o fluxo termina e a ligação segue com o atendente. Se o tempo máximo de espera da fila passar, segue pela saída 'timeout'; sem ela conectada, a ligação é encerrada.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
queue_id | select | Sim | Fila. Fila de atendimento que recebe a ligação. Origem das opções: call_queues. |
notes | textarea | Não | Nota para o atendente. Aparece para o atendente antes de ele atender. Aceita variáveis. |
Configuração padrão
{
"notes": "",
"queue_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
timeout | Ninguém atendeu | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
transferred | boolean | Verdadeiro quando um atendente assumiu a ligação. |
Atualizar Lead
Preenche no cadastro do lead da conversa o nome, o endereço, o bairro, a data de nascimento e campos personalizados.
- Tipo:
action_update_lead - Categoria:
action - Fluxos:
messages - Comportamento no teste:
writes_data
Quando usar: Depois de um passo que extraiu dados da conversa (agente de IA, requisição HTTP, variável), para gravar no cadastro do lead o nome, o CEP, o endereço, o bairro, a data de nascimento ou campos personalizados.
Como funciona: Só preenche o que está vazio no cadastro: um valor diferente já salvo nunca é substituído e aparece em conflicts. O nome é a exceção: substitui o nome do perfil do WhatsApp ou de uma importação, mas nunca um nome editado por uma pessoa nem o de um formulário. Com CEP, o CEP é conferido e cidade, UF e logradouro vêm dele; sem CEP, informe cidade e UF junto com o bairro ou o logradouro. O endereço vira o endereço principal e aguarda localização no mapa. Campos sensíveis nunca são gravados por fluxos. Campos vazios depois de trocar as variáveis são ignorados; sem nenhum dado, ou com um dado recusado, segue pela saída Erro sem gravar nada. Uma variável que não existe naquele ponto do fluxo nunca é gravada como texto: o passo segue pela saída Erro sem gravar nada e o rastro mostra a variável. {{message}} é a última mensagem do contato e só existe em fluxos iniciados ou retomados por uma mensagem. O fluxo fica registrado como autor da mudança.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
name | text | Não | Nome. Substitui o nome do perfil do WhatsApp; um nome editado por uma pessoa é mantido. |
zip_code | text | Não | CEP. 8 dígitos, com ou sem hífen. Aceita variáveis. |
street | text | Não | Logradouro. Rua ou avenida, sem o número. |
number | text | Não | Número do endereço. Número do imóvel, não o telefone. Precisa do CEP ou da cidade e UF. |
complement | text | Não | Complemento. |
district | text | Não | Bairro. |
city | text | Não | Cidade. Obrigatória sem CEP. |
state | text | Não | UF. Sigla ou nome do estado. Obrigatória sem CEP. |
birth_date | text | Não | Data de nascimento. DD/MM/AAAA ou AAAA-MM-DD. |
custom_fields | keyvalue | Não | Campos personalizados. Chave de um campo personalizado de lead e o valor a gravar. Seleção aceita só as opções do campo. |
Configuração padrão
{
"custom_fields": {}
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
sucesso | Sucesso | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
success | boolean | true quando o cadastro foi conferido sem recusa. |
lead_id | text | ID do lead da conversa. |
changed | list | Campos preenchidos agora: name, addresses, birthDate ou customFields.<chave>. |
conflicts | list | Campos que já tinham outro valor e foram mantidos. |
error | text | Motivo quando nada foi gravado. |
IA
Agente IA
Gera uma resposta usando o agente de IA e salva em uma variável.
- Tipo:
action_ai_agent - Categoria:
ai - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
ai_model
Quando usar: Para conversar com o contato usando IA, classificar intenção ou orquestrar ferramentas. source=prompt (defina model+instructions) para um agente ad-hoc; source=agent (defina agent_id) para reutilizar um agente salvo.
Como funciona: ENVIO: em response_mode=segmented o PRÓPRIO NÓ envia as mensagens no WhatsApp (divididas, com indicador de 'digitando'), não conecte um send_text depois (envio duplicado, é bloqueado). Em response_mode=default o nó também envia a resposta no WhatsApp; use um send_text apenas para enviar por outro canal, transformar o texto, ou quando o agente roteia para ferramentas (aí o nó NÃO envia). Com custom_tools, a IA escolhe uma ferramenta e o fluxo SAI pela saída cujo nome é o da ferramenta. Quando o caminho de uma ferramenta termina sem próxima aresta, o fluxo volta sozinho ao agente com o resultado, e quando um passo do caminho falha sem a saída erro conectada, volta com o erro; se o caminho terminar em end, action_finish_conversation, action_transfer_department, action_assign_member, action_transfer_to_queue ou action_reply_to_agent, a conversa sai do agente ali. Defina custom_tools ANTES de conectar. Ao chamar uma ferramenta, cada argumento fica acessível adiante como {{node.<id>.<arg>}} (ex.: {{node.n2.cep}}).
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
input_mode | select | Não | Modo de entrada. Valores: conversation (Conversa (histórico completo)), custom (Texto personalizado). |
response_mode | select | Não | Modo de resposta. Segmentada: divide a resposta em múltiplas mensagens curtas. No WhatsApp, envia cada mensagem com indicador de digitação automaticamente. Valores: default (Padrão (uma mensagem)), segmented (Segmentada (múltiplas mensagens + digitação)). |
text | textarea | Não | Texto de entrada. |
include_history | select | Não | Incluir histórico. Valores: no (Não), yes (Sim). |
source | select | Não | Fonte de IA. Modo do nó (padrão 'agent' quando vazio). 'agent': usa um agente salvo, preencha agent_id; model/instructions são ignorados. 'prompt': agente ad-hoc, preencha model e instructions; agent_id é ignorado. Valores: agent (Agente salvo), prompt (Prompt inline). |
agent_id | select | Não | Agente. Origem das opções: agents. |
model | select | Não | Modelo. Origem das opções: ai_models. |
reasoning_level | reasoning_level | Não | Nível de raciocínio. Só no modo 'prompt'. Um dos níveis que o modelo oferece em reasoning.levels (find_resource ai_models ou GET /agents/options); vazio usa o padrão do modelo. Um nível que o modelo não oferece é recusado ao salvar, ao ativar e na execução. |
instructions | textarea | Não | Prompt do sistema. |
additional_context | textarea | Não | Contexto adicional. |
context_window | number | Não | Janela de contexto (mensagens). |
response_variable | text | Não | Salvar resposta na variável. |
knowledge_base_ids | multi-select | Não | Bases de conhecimento. Bases de conhecimento para RAG. Quando usando um agente, as bases vinculadas ao agente são usadas automaticamente. Origem das opções: knowledge_bases. |
mcp_collection_ids | multi-select | Não | Coleções MCP. Coleções MCP que delimitam as ferramentas disponíveis para esta IA. Origem das opções: mcp_collections. |
custom_tools | tools | Não | Ferramentas. |
Configuração padrão
{
"additional_context": "",
"agent_id": "",
"context_window": 50,
"custom_tools": [],
"include_history": "yes",
"input_mode": "conversation",
"instructions": "",
"knowledge_base_ids": [],
"mcp_collection_ids": [],
"model": "",
"response_mode": "default",
"response_variable": "ai_response",
"source": "agent",
"text": "{{message}}"
}Saídas
As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.
Saídas fixas, além das que a configuração cria:
Saída (label) | Nome | Obrigatória |
|---|---|---|
default | Resposta (texto) | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
response_text | text | Resposta gerada pela IA. |
messages | list | Lista de mensagens segmentadas (quando modo segmentado). |
delivered | boolean | true se as mensagens foram enviadas diretamente pelo nó. |
agent_id | text | ID do agente utilizado. |
model | text | Modelo de IA utilizado. |
tool_name | text | Nome da ferramenta chamada pela IA (se houver). |
tool_args | object | Argumentos da ferramenta chamada (objeto JSON). |
Lógica
Código (JavaScript)
Executa JavaScript em um sandbox seguro. Tem acesso a input, state.get/set, fetch (HTTPS), secrets, log, json, b64, crypto, sleep. O valor retornado vira a saída do nó (acessível via {{last.<campo>}}).
- Tipo:
action_code - Categoria:
logic - Fluxos:
messagesevoice - Comportamento no teste:
external_call
Quando usar: Para lógica personalizada em sandbox JavaScript quando nenhum nó pronto resolve.
Como funciona: Os campos do objeto retornado pelo script tornam-se as saídas de dados deste nó (acessíveis adiante via {{node.<id>.<campo>}}). Roda em sandbox com input, state.get/set, fetch (HTTPS) e log.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
code | code | Sim | Código JavaScript. |
output_variable | text | Não | Salvar retorno em variável. Opcional. Se preenchido, o valor retornado pelo script também é gravado no estado do fluxo sob este nome (acessível por {{state.<nome>}} ou via state.get('<nome>') em nós seguintes). |
timeout_ms | number | Não | Timeout (ms). Tempo máximo do script, até 60000 ms (60 s). Limites: mínimo 1, máximo 60000. |
Configuração padrão
{
"code": "// ─────────────────────────────────────────────────────────────────────\n// Sandbox JavaScript, sem eval, sem require, sem timers, sem DOM.\n// Retorne um objeto → seus campos viram a saída deste nó, acessíveis\n// nos próximos nós como {{last.<campo>}}. Sem retorno → saída vazia.\n// ─────────────────────────────────────────────────────────────────────\n\n// ── Entrada ─────────────────────────────────────────────────────────\n// input Saída do nó anterior (objeto congelado).\n// Ex.: input.body, input.status\n\n// ── Estado do fluxo (persiste entre nós desta execução) ────────────\n// state.get(chave) Lê uma variável salva antes.\n// state.set(chave, valor) Escreve uma variável (auditado).\n//\n// Chaves com pontos viram caminho aninhado, igual aos templates\n// {{a.b.c}}. Ex.: o nó AI Agent grava \"ai_response\" como objeto;\n// para ler o argumento \"query\" da chamada de ferramenta, use:\n// state.get(\"ai_response.tool_args.query\")\n// Índices numéricos viajam em arrays: state.get(\"hits.0.title\").\n\n// ── Log (aparece no log da execução) ───────────────────────────────\n// log('info', 'mensagem', obj)\n// // Níveis: 'debug' | 'info' | 'warn' | 'error'\n\n// ── HTTP (somente HTTPS, com proteção SSRF) ────────────────────────\n// // Bloqueia IPs privados/loopback/metadata da nuvem.\n// fetch('https://api.exemplo.com/x')\n// fetch({\n// url: 'https://api.exemplo.com/x',\n// method: 'POST',\n// headers: { 'X-Api-Key': secrets.get('minha_chave') },\n// body: { ola: 'mundo' }, // objeto → vira JSON automaticamente\n// timeout_ms: 3000,\n// })\n// // → { status, ok, headers, body, url, duration_ms }\n\n// ── Segredos (escopo do workspace, nunca enumeráveis) ──────────────\n// secrets.get('stripe_key') Lança erro se não estiver autorizado.\n\n// ── JSON ────────────────────────────────────────────────────────────\n// json.parse(texto)\n// json.stringify(valor)\n\n// ── Base64 ──────────────────────────────────────────────────────────\n// b64.encode(texto)\n// b64.decode(texto)\n\n// ── Cripto ──────────────────────────────────────────────────────────\n// crypto.uuid() gera UUID v4\n// crypto.hash('sha256', 'texto') também 'sha1' e 'md5'\n\n// ── Aleatoriedade (Math padrão; NÃO use p/ segurança) ──────────────\n// Math.random() 0..1\n// Math.floor(Math.random() * 10) inteiro 0..9\n// crypto.uuid() use isto p/ unicidade real\n\n// ── Datas (Date padrão do JS) ──────────────────────────────────────\n// new Date() agora\n// Date.now() epoch em ms\n// new Date().toISOString() '2026-05-22T12:34:56.789Z'\n// new Date(Date.now() + 86400000) amanhã\n// new Date('2026-12-31').getTime() parse → epoch ms\n\n// ── Strings, números, arrays, regex, ES5+ padrão ──────────────────\n// 'oi'.toUpperCase()\n// [1, 2, 3].map(x => x * 2)\n// /\\d+/.test('abc123')\n\n// ── Pausa (conta no orçamento de tempo) ────────────────────────────\n// sleep(250) pausa 250 ms\n\n// ── Limites (padrão; podem ser menores no seu plano) ───────────────\n// tempo 5 s (até 60 s em Timeout) · saída ≤ 256 KB · log ≤ 64 KB\n// fetch ≤ 20 chamadas · resposta ≤ 5 MB\n\n// ─────────────────────────────────────────────────────────────────────\n\nreturn {\n ok: true,\n saudacao: 'Olá ' + (input.nome || 'mundo'),\n em: new Date().toISOString(),\n};\n",
"output_variable": "",
"timeout_ms": 5000
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
* | não informado | Os campos do objeto retornado pelo script. Use {{last.<campo>}}. |
Formatar Data/Hora
Formata, converte ou calcula datas e horários.
- Tipo:
action_format_date - Categoria:
logic - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para formatar/converter/calcular datas e horas.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
input | text | Sim | Entrada. |
format | select | Não | Formato de saída. Valores: 2006-01-02 15:04:05 (YYYY-MM-DD HH:mm:ss), 2006-01-02 (YYYY-MM-DD), 02/01/2006 (DD/MM/YYYY), 02/01/2006 15:04 (DD/MM/YYYY HH:mm), 15:04:05 (HH:mm:ss), 15:04 (HH:mm), Monday (Dia da semana), January (Mês por extenso), unix (Timestamp Unix). |
timezone | select | Não | Fuso horário. Valores: America/Sao_Paulo (São Paulo (BRT)), America/New_York (Nova York (EST)), America/Chicago (Chicago (CST)), America/Los_Angeles (Los Angeles (PST)), Europe/London (Londres (GMT)), Europe/Paris (Paris (CET)), Asia/Tokyo (Tóquio (JST)), UTC (UTC). |
operation | select | Não | Operação. Valores: none (Nenhuma), add (Adicionar tempo), subtract (Subtrair tempo). |
amount | number | Não | Quantidade. |
unit | select | Não | Unidade. Valores: minutes (Minutos), hours (Horas), days (Dias), weeks (Semanas), months (Meses). |
Configuração padrão
{
"amount": 0,
"format": "2006-01-02 15:04:05",
"input": "now",
"operation": "none",
"timezone": "America/Sao_Paulo",
"unit": "hours"
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
formatted | text | Data formatada como string. |
timestamp | number | Timestamp Unix (segundos). |
iso | date | Data em formato ISO 8601. |
Hora Atual
Obtém a data e hora atual e salva em variáveis.
- Tipo:
action_get_current_time - Categoria:
logic - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para obter a data/hora atual em um fuso e usar adiante.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
timezone | select | Não | Fuso horário. Valores: America/Sao_Paulo (São Paulo (BRT)), America/New_York (Nova York (EST)), America/Chicago (Chicago (CST)), America/Los_Angeles (Los Angeles (PST)), Europe/London (Londres (GMT)), Europe/Paris (Paris (CET)), Asia/Tokyo (Tóquio (JST)), UTC (UTC). |
variable | text | Não | Salvar como variável. |
Configuração padrão
{
"timezone": "America/Sao_Paulo",
"variable": "current_time"
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
datetime | text | Data e hora completa (YYYY-MM-DD HH:mm:ss). |
date | date | Apenas a data (YYYY-MM-DD). |
time | text | Apenas a hora (HH:mm:ss). |
hour | number | Hora (0-23). |
minute | number | Minuto (0-59). |
weekday | text | Dia da semana (Monday, Tuesday, etc.). |
timestamp | number | Timestamp Unix (segundos). |
iso | date | Data em formato ISO 8601. |
Loop / Iteração
Itera sobre uma lista (array JSON). A cada passagem define o item atual e o índice.
- Tipo:
action_loop - Categoria:
logic - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para iterar sobre uma lista (list_variable).
Como funciona: Percorre a lista item a item: a saída 'body' executa uma vez por item (normalmente retornando ao próprio loop para iterar) e a saída 'done' segue ao terminar. Um ciclo de volta ao loop é válido; o loop garante o término.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
list_variable | text | Sim | Variável da lista. |
item_variable | text | Não | Nome do item. |
Configuração padrão
{
"item_variable": "item",
"list_variable": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
body | Corpo do loop | Sim |
done | Concluído | Sim |
fail | Falha | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
item | unknown | Item atual da iteração. |
index | number | Índice da iteração atual (0-based). |
total | number | Total de itens na lista. |
is_first | boolean | true se é o primeiro item. |
is_last | boolean | true se é o último item. |
Definir Variável
Define uma variável no estado do fluxo.
- Tipo:
action_set_variable - Categoria:
logic - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para gravar/derivar uma variável de fluxo reutilizável adiante.
Como funciona: Grava a variável de fluxo (nome em 'variable') com o 'value' já interpolado; fica disponível adiante como {{var.<nome>}}. Se o valor cita uma variável que não existe naquele ponto do fluxo, a variável não é gravada e o rastro mostra qual faltou.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
variable | text | Sim | Nome da Variável. |
variable_label | text | Não | Nome amigável. Como a variável aparece nas listas e nos campos. |
value | text | Não | Valor. |
Configuração padrão
{
"value": "",
"variable": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
variable | não informado | Nome da variável definida. Repete o valor da configuração. |
value | não informado | Valor atribuído. Repete o valor da configuração. |
Condições
Condição
Divide o fluxo com base em uma condição (campo, operador, valor).
- Tipo:
condition_branch - Categoria:
condition - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para uma decisão booleana sobre uma variável (operadores: eq, contains, gt, empty, matches, in, etc.).
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
variable | text | Sim | Variável. Texto ou referência de estado. Use {{...}} para interpolar (ex.: {{node.n2.count}}, {{var.status}}). |
operator | select | Sim | Operador. Valores: eq (Igual a (==)), neq (Diferente de (!=)), eq_ci (Igual (ignorar maiúsc.)), neq_ci (Diferente (ignorar maiúsc.)), contains (Contém), not_contains (Não contém), contains_ci (Contém (ignorar maiúsc.)), starts_with (Começa com), ends_with (Termina com), empty (Está vazio), not_empty (Não está vazio), is_null (É nulo), is_not_null (Não é nulo), gt (Maior que (>)), gte (Maior ou igual (>=)), lt (Menor que (<)), lte (Menor ou igual (<=)), matches (Corresponde a regex), not_matches (Não corresponde a regex), is_number (É número), is_not_number (Não é número), is_true (É verdadeiro), is_false (É falso), length_eq (Comprimento igual a), length_gt (Comprimento maior que), length_lt (Comprimento menor que), in (Está na lista (vírgula)), not_in (Não está na lista (vírgula)). |
value | text | Não | Valor. |
Configuração padrão
{
"operator": "eq",
"value": "",
"variable": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
true | Verdadeiro | Sim |
false | Falso | Sim |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
matched | boolean | true ou false (resultado da condição). |
variable | não informado | Nome da variável avaliada. Repete o valor da configuração. |
operator | não informado | Operador utilizado. Repete o valor da configuração. |
Canal
Divide o fluxo pelo canal em que a conversa está acontecendo.
- Tipo:
condition_channel - Categoria:
condition - Fluxos:
messages - Comportamento no teste:
pure
Quando usar: Quando o mesmo fluxo atende vários canais e um trecho precisa mudar (ex.: template no WhatsApp oficial, texto simples no resto).
Configuração
Sem campos de configuração.
Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
whatsapp | WhatsApp oficial | Sim |
unofficial_whatsapp | WhatsApp não oficial | Sim |
instagram | Sim | |
telegram | Telegram | Sim |
facebook | Messenger | Sim |
webchat | WebChat | Sim |
mercadolivre | Mercado Livre | Sim |
tiktok | TikTok | Sim |
email | Sim | |
rcs | RCS | Sim |
sms | SMS | Sim |
default | Outros canais | Sim |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
channel | text | Canal da execução (whatsapp, instagram, telegram, ...). |
matched | boolean | true quando havia uma aresta para esse canal; false quando caiu no padrão. |
Verificar Etiqueta
Verifica se a entrada possui uma etiqueta específica.
- Tipo:
condition_check_label - Categoria:
condition - Fluxos:
messages - Comportamento no teste:
reads_data
Quando usar: Para verificar se a conversa tem uma etiqueta específica.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
label_id | select | Sim | Etiqueta. Origem das opções: labels. |
Configuração padrão
{
"label_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
true | Possui | Sim |
false | Não Possui | Sim |
erro | Erro | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
matched | boolean | true se a entrada possui a etiqueta. |
label_id | não informado | ID da etiqueta verificada. Repete o valor da configuração. |
label_name | text | Nome da etiqueta (se encontrada). |
error | text | Motivo quando as etiquetas não puderam ser lidas (saída Erro). |
Verificar Negociação
Verifica as negociações da conversa: se existem, se há mais de uma aberta, a situação ou a etapa.
- Tipo:
condition_check_opportunity - Categoria:
condition - Fluxos:
messages - Comportamento no teste:
reads_data
Quando usar: Para seguir caminhos diferentes conforme a conversa já tenha uma negociação, ela esteja ganha ou em uma etapa.
Como funciona: Considera a negociação do ID informado ou a única negociação aberta da conversa no funil; sem aberta, a última encerrada. Com mais de uma aberta e sem ID, verificar situação ou etapa interrompe a execução. A saída lista todas as negociações para usar em um Loop.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
pipeline_id | select | Sim | Funil de negociações. O funil de negociações onde fica a negociação desta conversa. Origem das opções: opportunity_pipelines. |
check | select | Sim | Verificar. Valores: exists (Tem negociação), several_open (Tem mais de uma negociação aberta), status (Situação da negociação é), stage (Negociação está na etapa). |
opportunity_id | text | Não | ID da negociação. Opcional. Vazio: a única negociação aberta da conversa neste funil ou, sem aberta, a última encerrada. Vale quando check é exists, status ou stage. |
status | select | Quando check é status | Situação. Valores: open (Aberto), won (Ganho), lost (Perdido). Vale quando check é status. |
stage_id | select | Quando check é stage | Etapa da negociação. Etapa a comparar. Origem das opções: opportunity_stages. Vale quando check é stage. |
Configuração padrão
{
"check": "exists",
"pipeline_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
true | Sim | Sim |
false | Não | Sim |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
matched | boolean | true quando a verificação foi atendida. |
opportunity_id | text | ID da negociação (vazio se não há). |
status | text | Situação da negociação: open, won ou lost. |
stage_id | text | ID da etapa da negociação. |
value_cents | number | Valor em centavos. |
value | number | Valor na unidade da moeda. |
open_count | number | Quantidade de negociações abertas da conversa no funil. |
opportunities | list | Lista das negociações da conversa no funil, abertas primeiro. |
Verificar Etapa
Verifica se a conversa está em uma etapa do funil.
- Tipo:
condition_check_stage - Categoria:
condition - Fluxos:
messages - Comportamento no teste:
reads_data
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
stage_id | select | Sim | Etapa. A etapa a comparar com a etapa atual da conversa. Origem das opções: stages. |
Configuração padrão
{
"stage_id": ""
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
true | Está na etapa | Sim |
false | Não está | Sim |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
matched | boolean | true se a conversa está na etapa escolhida. |
stage_id | não informado | ID da etapa verificada. Repete o valor da configuração. |
current_stage_id | text | ID da etapa atual da conversa (vazio se não há). |
current_stage_name | text | Nome da etapa atual da conversa. |
Lead tem consentimento?
Segue pelo estado do consentimento do lead da conversa: concedido, retirado ou sem registro.
- Tipo:
condition_consent - Categoria:
condition - Fluxos:
messages - Comportamento no teste:
reads_data
Quando usar: Para seguir caminhos diferentes conforme o lead da conversa aceitou receber mensagens, pediu para parar ou não tem registro.
Como funciona: Lê o registro atual do lead. Uma conversa sem lead segue por 'none'. Uma falha de leitura interrompe a execução em vez de escolher um caminho.
Configuração
Sem campos de configuração.
Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
granted | Tem consentimento | Sim |
withdrawn | Pediu para não receber | Sim |
none | Sem registro | Sim |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
state | text | granted, withdrawn ou none. |
lead_id | text | ID do lead da conversa (vazio se não há). |
Filtro
Continua o fluxo apenas se a condição for verdadeira. Caso contrário, encerra.
- Tipo:
condition_filter - Categoria:
condition - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para continuar só se a condição for verdadeira; caso contrário a execução encerra ali.
Como funciona: Quando a condição é falsa, a execução do fluxo ENCERRA neste nó; quando verdadeira, segue pela saída para o próximo nó.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
variable | text | Sim | Variável. Texto ou referência de estado. Use {{...}} para interpolar (ex.: {{node.n2.count}}, {{var.status}}). |
operator | select | Sim | Operador. Valores: eq (Igual a (==)), neq (Diferente de (!=)), eq_ci (Igual (ignorar maiúsc.)), neq_ci (Diferente (ignorar maiúsc.)), contains (Contém), not_contains (Não contém), contains_ci (Contém (ignorar maiúsc.)), starts_with (Começa com), ends_with (Termina com), empty (Está vazio), not_empty (Não está vazio), is_null (É nulo), is_not_null (Não é nulo), gt (Maior que (>)), gte (Maior ou igual (>=)), lt (Menor que (<)), lte (Menor ou igual (<=)), matches (Corresponde a regex), not_matches (Não corresponde a regex), is_number (É número), is_not_number (Não é número), is_true (É verdadeiro), is_false (É falso), length_eq (Comprimento igual a), length_gt (Comprimento maior que), length_lt (Comprimento menor que), in (Está na lista (vírgula)), not_in (Não está na lista (vírgula)). |
value | text | Não | Valor. |
Configuração padrão
{
"operator": "eq",
"value": "",
"variable": ""
}Saídas
Uma única saída: a conexão vai sem label (ou com default).
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
passed | boolean | true se o filtro deixou passar. |
variable | não informado | Nome da variável avaliada. Repete o valor da configuração. |
Classificar Texto
Roteia o fluxo com base no texto recebido (switch/case).
- Tipo:
condition_text_match - Categoria:
condition - Fluxos:
messagesevoice - Comportamento no teste:
pure
Quando usar: Para rotear por correspondência de texto (switch/case) sem custo de IA.
Como funciona: Saídas DINÂMICAS: cada item de 'cases' cria uma saída (rótulo igual ao value do case), preencha 'cases' ANTES de conectar. Há sempre uma saída 'default' para quando nada corresponde.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
text | text | Sim | Texto. |
cases | cases | Não | Casos. |
match_mode | select | Não | Modo de comparação. Valores: exact (Exato), contains (Contém). |
Configuração padrão
{
"cases": [],
"match_mode": "exact",
"text": "{{message}}"
}Saídas
As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.
Saídas fixas, além das que a configuração cria:
Saída (label) | Nome | Obrigatória |
|---|---|---|
default | Padrão | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
matched | text | Valor do caso que correspondeu (vazio se padrão). |
text | não informado | Texto avaliado. Repete o valor da configuração. |
Esperas
Aguardar Tecla
Espera quem ligou apertar uma tecla de um menu ou digitar um valor, como CPF, data ou telefone.
- Tipo:
wait_dtmf - Categoria:
wait - Fluxos:
voice - Comportamento no teste:
voice_only
Quando usar: Para ler a opção de um menu de URA ou pedir que quem ligou digite um valor (CPF, CNPJ, data, telefone, número, valor em centavos, CEP). Coloque depois de um action_play_audio que faz a pergunta.
Como funciona: 'mode' menu (o padrão): saídas DINÂMICAS, cada tecla em 'keys' (0-9, * ou #) vira uma saída com o próprio dígito como rótulo; conecte todas; a tecla fica em 'key'. 'mode' collect: quem ligou digita vários dígitos e termina com 'finish_key' (# por padrão), com uma pausa maior que 'digit_timeout_seconds' ou ao completar o tamanho do tipo; o valor é conferido pela regra do tipo em 'input_type' e sai por 'collected' com o valor em 'value' (e em {{var.<variable>}} quando 'variable' está preenchido) e o que foi digitado em 'digits'. 'invalid' recebe teclas fora do menu ou um valor que não passa na regra; 'timeout' recebe o silêncio após 'timeout_seconds' (até 60). Se não forem conectadas, a ligação é encerrada. Para pedir de novo, ligue 'invalid' ou 'timeout' de volta ao áudio; 'max_attempts' limita essas voltas e a última falha sai por 'attempts_exhausted' (sem conexão, a ligação é encerrada).
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
mode | select | Não | O que esperar. Valores: menu (Uma tecla de um menu), collect (Um valor digitado). |
keys | multi-select | Quando mode é vazio ou menu | Teclas. Cada tecla escolhida vira uma saída. Valores: 0 (0), 1 (1), 2 (2), 3 (3), 4 (4), 5 (5), 6 (6), 7 (7), 8 (8), 9 (9), * (*), # (#). Vale quando mode é vazio ou menu. |
input_type | select | Quando mode é collect | Tipo do valor. O valor só sai por Valor recebido quando passa na regra do tipo; data é digitada como DDMMAAAA. Valores: digits (Dígitos digitados), number (Número digitado), cpf (CPF digitado), cnpj (CNPJ digitado), cpf_cnpj (CPF ou CNPJ digitado), date (Data digitada), phone (Telefone digitado), money_cents (Valor digitado em centavos), cep (CEP digitado). Vale quando mode é collect. |
min_digits | number | Não | Mínimo de dígitos. Limites: mínimo 1, máximo 32. Vale quando input_type é digits, number ou money_cents. |
max_digits | number | Não | Máximo de dígitos. Ao chegar no máximo, a digitação termina sem precisar da tecla de fim. Limites: mínimo 1, máximo 32. Vale quando input_type é digits, number ou money_cents. |
finish_key | select | Não | Tecla para terminar. Valores: # (#), * (*). Vale quando mode é collect. |
timeout_seconds | number | Não | Esperar a primeira tecla até (segundos). Até 60 segundos. |
digit_timeout_seconds | number | Não | Pausa entre dígitos (segundos). Uma pausa maior termina a digitação. Limites: mínimo 1, máximo 60. Vale quando mode é collect. |
max_attempts | number | Não | Máximo de tentativas. Conta as falhas (tecla ou valor inválido e silêncio); a última sai por Tentativas esgotadas. Limites: mínimo 0, máximo 10. |
variable | text | Não | Guardar na variável. Opcional. O valor válido fica em {{var.<nome>}} para os próximos passos. Vale quando mode é collect. |
variable_label | text | Não | Nome amigável. Como a variável aparece nas listas e nos campos. Vale quando mode é collect. |
Configuração padrão
{
"keys": [],
"mode": "menu",
"timeout_seconds": 8
}Saídas
As saídas deste nó dependem da configuração (veja Como funciona). POST /workflows/resolve-handles e o campo handles de GET /workflows/{id} devolvem as saídas atuais de cada nó.
Saídas fixas, além das que a configuração cria:
Saída (label) | Nome | Obrigatória |
|---|---|---|
invalid | Tecla inválida | Não |
timeout | Sem resposta | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
key | text | Tecla pressionada no menu (vazio quando ninguém apertou). |
value | unknown | Valor digitado e validado, no tipo escolhido (vazio quando a entrada é inválida). |
digits | text | Teclas digitadas, sem a tecla de fim (também quando a entrada é inválida). |
Aguardar Duração
Pausa o fluxo por um tempo determinado.
- Tipo:
wait_duration - Categoria:
wait - Fluxos:
messages - Comportamento no teste:
waits
Quando usar: Para pausar o fluxo por um tempo fixo.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
seconds | number | Sim | Duração (segundos). |
Configuração padrão
{
"seconds": 60
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
completed | Tempo passou | Sim |
message_received | Mensagem recebida | Não |
Aguardar Resposta
Pausa o fluxo até o contato responder ou expirar o tempo.
- Tipo:
wait_for_reply - Categoria:
wait - Fluxos:
messages - Precisa de conversa: sim
- Comportamento no teste:
waits
Quando usar: Para pausar e aguardar a próxima mensagem do contato (essencial para conversa contínua).
Como funciona: Pausa o fluxo até o contato responder. Padrão conversacional: conecte 'replied' de volta ao agente e 'timeout' para encerrar; o ciclo é válido porque o wait garante término.
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
timeout_seconds | number | Sim | Timeout (segundos). |
Configuração padrão
{
"timeout_seconds": 300
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
replied | Respondeu | Sim |
timeout | Não respondeu | Não |
Esperar Horário
Pausa o fluxo até uma data/hora específica. Ideal para enviar mensagens em horários programados.
- Tipo:
wait_schedule - Categoria:
wait - Fluxos:
messages - Comportamento no teste:
waits
Quando usar: Para pausar até uma data/horário específico (envios agendados).
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
mode | select | Sim | Modo. Valores: time (Horário específico (ex: 16:00)), datetime (Data e hora exata), next_weekday (Próximo dia da semana). |
time | text | Não | Horário (HH:mm). |
date | text | Não | Data (YYYY-MM-DD). |
weekday | select | Não | Dia da semana. Valores: Monday (Segunda-feira), Tuesday (Terça-feira), Wednesday (Quarta-feira), Thursday (Quinta-feira), Friday (Sexta-feira), Saturday (Sábado), Sunday (Domingo). |
timezone | select | Não | Fuso horário. Valores: America/Sao_Paulo (São Paulo (BRT)), America/New_York (Nova York (EST)), America/Chicago (Chicago (CST)), America/Los_Angeles (Los Angeles (PST)), Europe/London (Londres (GMT)), Europe/Paris (Paris (CET)), Asia/Tokyo (Tóquio (JST)), UTC (UTC). |
Configuração padrão
{
"date": "",
"mode": "time",
"time": "09:00",
"timezone": "America/Sao_Paulo"
}Saídas
Saída (label) | Nome | Obrigatória |
|---|---|---|
completed | Horário atingido | Sim |
message_received | Mensagem recebida | Não |
Chaves de saída
| Chave | Tipo | Descrição |
|---|---|---|
scheduled_at | date | Data/hora agendada (ISO 8601). |
wait_minutes | number | Minutos de espera calculados. |
Fim
Fim
Finaliza a execução do fluxo. Em fluxos de chamada, desliga a ligação.
- Tipo:
end - Categoria:
end - Fluxos:
messagesevoice - Comportamento no teste:
end
Quando usar: Para encerrar um caminho do fluxo. Todo grafo precisa de ao menos um caminho que chegue a um 'end'.
Configuração
Sem campos de configuração.
Saídas
Encerra o caminho e não tem saídas.
Decoração
Plano de Fundo
Elemento de decoração para organizar visualmente o fluxo. Não tem impacto na execução.
- Tipo:
decoration_background - Categoria:
decoration - Fluxos:
messages - Comportamento no teste:
decoration
Configuração
| Campo | Tipo | Obrigatório | Significado |
|---|---|---|---|
color | color | Não | Cor de Fundo. |
Configuração padrão
{
"color": "#f0f0f0"
}Saídas
Não participa da execução e não tem saídas.