Webhooks
The Webhooks screen is for registering the endpoint through which the company's system notifies the panel, setting rules for each notice, and registering the addresses of the company's system that receive the panel's notices.
Address in the dashboard: /app/automacoes/webhooks
How to get there: Through the menu "Automações" (Automations) › Webhooks. The old address under "Integrações" (Integrations) brings you here; each tab has its own address, so you can send the link to a specific tab.
Header and tabs
The title, the create button, and the two tabs.
Buttons and actions
- "Novo webhook" (New webhook)
- Opens the creation wizard, already set to the direction of the open tab. Only appears for those who can create.
- "Entrada" (Input)
- Tab for the notices that the company's system sends to the panel. The number beside it is the number of events.
- "Saída" (Outbound)
- Tab for the addresses that receive the panel's notices. The number beside it is the number of webhooks.
- A panel reminds you that "Entrada" (Input) used to be in the "Base avançada" (Advanced base) and "Saída" (Output) in "Integrações" (Integrations).
- The tabs move with the keyboard arrow keys.
- When the account does not have "Entrada" (Input), only the "Saída" (Output) tab appears.
"Entrada" (Input) tab: endpoint and secret
The signed endpoint that the company's system calls to notify the panel.
Buttons and actions
- "Copiar o endereço" (Copy the address)
- Copies the address to register in the company's system.
- "Mostrar" (Show)
- Reveals the signing secret so you can copy it (it is logged).
- "Ocultar" (Hide)
- Masks the secret again.
- "Copiar o segredo" (Copy the secret)
- Copies the revealed secret.
- "Trocar" (Change)Owner
- Asks "Trocar o segredo?" (Change the secret?): the new one is valid immediately and the current one stays valid for 24 hours.
- "Trocar agora" (Replace now)
- Confirms the change and shows the new secret.
- "Invalidar o antigo agora" (Invalidate the old one now)Owner
- With the previous secret still valid, asks and cuts it off immediately (use it if it leaked).
- "Invalidar agora" (Invalidate now)
- Confirms: notices signed with the old secret start being rejected.
- "Mais ações do endereço" (More address actions)
- Opens the endpoint menu.
- "Arquivar endereço" (Archive address)
- When there are already deliveries in the history: the endpoint goes to the archive.
- "Excluir endereço" (Delete address)
- When a notice has never arrived: deletes it for good.
- "Criar endereço novo" (Create new address)Owner
- With the endpoint archived, generates another endpoint and another secret. The named events and the rules (turned off) stay.
- "Situação" (Status): "Recebendo" (Receiving), "Último há tanto tempo" (Last one X ago), "Sem avisos ainda" (No notices yet) or "Arquivado" (Archived).
- One notice per lead every 7 days, at most.
- A tip with the signature headers of each notice.
"Entrada" (Input) tab: events, deliveries, and rules
What the system has already sent, each event with a name in Portuguese, and the rule for each one.
Fields and filters
- "Chave do evento" (Event key)required
- What goes in the event field of the body (letters, numbers, period, dash, or underscore).
- "Nome em português" (Name in Portuguese)required
- How the event appears on the screen.
- "Etiqueta do CRM" (CRM tag)
- Leads with this tag in the "Base de contatos" (Contact base) receive the notice.
- "Modelo aprovado da Meta" (Meta-approved template)
- Outside the 24 hours, the template used; with no template, the notice is not sent outside the window.
- "No máximo 1 aviso por lead a cada" (At most 1 notice per lead every)
- 7, 14 or 30 days.
- "Corpo de exemplo" (Sample body)
- The JSON of the simulated notice, filled in with the last notice received.
Buttons and actions
- "Regra" (Rule)
- Opens a new rule (it needs at least one event).
- "Evento" (Event)
- Opens "Cadastrar um evento" (Register an event), to register the key before the system sends it.
- "nomear" (name)
- On an event without a name yet, opens "Nomear o evento" (Name the event).
- "Editar" (Edit)
- Opens the rule for editing.
- "Excluir regra" (Delete rule)Owner
- Asks "Excluir esta regra?" (Delete this rule?); notices already sent stay on record.
- "Regra ativa" (Active rule)
- Switch that turns the rule on or off; the rule is created turned off.
- "Enviar evento de teste" (Send test event)
- Simulates the notice with a sample body and shows the signature, how many leads would receive it, and the proposed fact. Nothing is sent.
- Each event shows how many arrived in the month; clicking it shows the rule on the right.
- Latest deliveries: each call to the endpoint as accepted, refused, or repeated, with the time and, when a lead did not receive it, the reason.
- The rule has "Quando" (When), "Para os leads de uma etiqueta" (For the leads with a tag), and the steps under "Faça" (Do): propose a fact for approval, send a message to the lead, remove from the list, and mark a lead field.
- Within the 24 hours, the AI writes with the account's persona; outside it, it uses the approved template.
"Saída" (Output) tab: webhook card
One card per address of the company's system. Only the owner sees the tab.
Buttons and actions
- "Ativo" (Active)
- Switch that pauses or activates the webhook. When paused, nothing is sent, and events from that period are not queued.
- "Reativar" (Reactivate)
- On the automatic pause notice, resumes sending the next notices.
- "Ver as falhas" (View failures)
- On the automatic pause notice, opens the deliveries drawer already on "Falharam" (Failed).
- "Entregas" (Deliveries)
- Opens the drawer with this webhook's deliveries.
- "Testar" (Test)
- Opens the "Enviar evento de teste" (Send test event) dialog.
- "Editar webhook ‹endereço›" (Edit webhook ‹URL›)
- Opens the edit form.
- "Excluir webhook ‹endereço›" (Delete webhook ‹URL›)
- Opens the delete confirmation.
- Badge "Ativo" (Active), "Pausado" (Paused), or "Pausado automaticamente" (Paused automatically), and "Com dados pessoais" (With personal data) or "Sem dados pessoais" (Without personal data).
- The events the address receives and the health of the last 7 days, with the percentage delivered, the failures, and the last send.
- The card "Para quem vai programar o recebimento" (For whoever will set up the receiving) has the signature headers and how the system should respond, with the "Documentação dos webhooks" (Webhooks documentation) button.
- Each notice goes out signed; the documentation remains under "Integrações" (Integrations) › "Documentação" (Documentation).
"Novo webhook" (New webhook) wizard
Step 1 of 2: choose the direction and fill in the details. Then, the "Webhook criado" (Webhook created) screen.
Fields and filters
- "Nome" (Name)required
- In "Entrada" (Input): a name that says where the notice comes from, such as "Pedido pago" (Order paid). The event key comes from the name.
- "Endereço do seu sistema" (Your system's address)required
- In "Saída" (Output): the full address starting with https:// that will receive the notices.
- "Eventos" (Events)required
- In "Saída" (Output): choose at least one event from the catalog.
Buttons and actions
- "Entrada: o seu sistema avisa" (Inbound: your system notifies us)
- Direction in which the company's system notifies the panel. Disabled without access to "Entrada" (Input).
- "Saída: a plataforma avisa" (Outbound: the platform notifies)
- Direction in which the panel notifies the company's system. Owner only.
- "Criar webhook" (Create webhook)
- Creates the webhook and shows the "Webhook criado" (Webhook created) screen.
- "Cancelar" (Cancel)
- Closes without creating.
- "Copiar o endereço" (Copy the address)
- On "Webhook criado" (Webhook created) ("Entrada" (Input)), copies the address for the company's system.
- "Copiar o segredo" (Copy the secret)
- On "Webhook criado" (Webhook created) ("Saída" (Output)), copies the signature secret, shown only once.
- "Pronto" (Done)
- Closes the "Webhook criado" (Webhook created) screen.
- In "Entrada" (Input), after creating, you write the rule: what message the AI sends and to whom. The state is "Escutando" (Listening) and becomes active when the first notice arrives.
- In "Saída" (Output), the secret appears only once; you can generate another at any time.
Screen states
- Loading
- Skeleton blocks while "Saída" (Output) and "Entrada" (Input) load.
- Nothing here yet
- "Nenhum webhook de entrada" (No inbound webhook) (with "Criar webhook de entrada" (Create inbound webhook)) and "Nenhum webhook de saída" (No outbound webhook) (with "Criar webhook de saída" (Create outbound webhook)).
- If something goes wrong
- "Não foi possível abrir os webhooks" (The webhooks could not be opened), saying that nothing changed, with the try-again button.
- "Entrada" (Input) without the "Base avançada" (Advanced base) module
- Inbound webhooks belong to the "Base avançada" (Advanced base), with the "Conhecer a Base avançada" (Learn about the Advanced base) button.
- Administrator on "Saída" (Output)
- The notice that the tab stays with the account owner.
- "Atendente" (Agent) or manager without access to "Entrada" (Input)
- Inbound webhooks stay with account management; ask one of those people to open the tab.
- Archived inbound endpoint
- The system can no longer notify; the rules stay turned off until a new endpoint is created.
- Panel domain not yet configured
- The inbound endpoint only appears after the domain is ready.