Integrations: receive leads via API, notify your CRM by webhook, and send conversions back to Meta

Screen header

The title, the supporting sentence, and the buttons that change depending on the open tab.

Buttons and actions

"Documentação da API" (API documentation)

On the "Entrada de leads" (Lead intake) tab, opens the "API de entrada de leads" (Lead intake API) documentation to hand to whoever programs your system. Depending on the dashboard URL, it opens in a new tab or inside the dashboard itself.

"Nova integração" (New integration)Owner

On the "Entrada de leads" (Lead intake) tab, opens the four-step wizard that creates an integration and shows its key only once.

"Como receber" (How to receive)Owner

On the Webhooks tab, scrolls to the "Para quem vai programar o recebimento" (For whoever will program the receiving end) card; with no webhook created, opens the webhooks guide in the "Central de ajuda" (Help center).

"Novo webhook" (New webhook)Owner

On the Webhooks tab, opens the form to register an endpoint (URL) that will receive the notices.

"Ver os webhooks" (View webhooks)Owner

On the "Entregas" (Deliveries) tab, goes back to the Webhooks tab.

"Como funciona" (How it works)

On the "Conversões" (Conversions) tab, opens the conversions guide in the "Central de ajuda" (Help center).

• Title "Integrações" (Integrations) and the sentence "Receber leads, avisar seus sistemas e medir anúncios" (Receive leads, notify your systems, and measure ads).
• The buttons in the right corner depend on the tab: "Entrada de leads" (Lead intake), Webhooks, "Entregas" (Deliveries), and "Conversões" (Conversions) have their own buttons; "Pedidos" (Orders) has none.

Screen tabs

The row of tabs that switches the content without leaving the screen.

Buttons and actions

"Entrada de leads" (Lead intake)

Shows the integrations that receive leads through the API, with the number of integrations next to the name.

Webhooks

Shows the endpoints (URLs) that receive notifications from the dashboard, with the number of webhooks next to the name (Owner only).

"Entregas" (Deliveries)

Shows the log of everything sent to your systems through webhooks.

"Conversões" (Conversions)

Shows the setup and the log of conversions sent back to Meta ads. It carries the "Novo" (New) badge.

"Pedidos" (Orders)

Shows the key and the example for your system to send sales orders.

• With focus on a tab, the right and left arrow keys move to the neighboring tab.
• On a narrow screen, the row of tabs scrolls by itself to the chosen tab.

"Pedidos" (Orders) tab

Receives sales from your ERP, online store, or another system to feed the RFV of the "Monitor de sucesso" (Success monitor).

Fields and filters

"URL de ingestão" (Ingestion URL)

The endpoint (URL) your system sends orders to, with a copy button beside it.

"Chave de API (X-Api-Key)" (API key (X-Api-Key))

The account key for orders, shown masked. With no key, it shows "Nenhuma chave gerada" (No key generated).

"Exemplo (curl)" (Example (curl))

A ready-made example of sending an order, with the key in the right place once it is generated.

Buttons and actions

"Gerar chave" (Generate key)

Creates the first orders key and shows the full key only once, with a notice to copy it right away.

"Gerar nova chave" (Generate new key)

Creates a new key right away, without asking for confirmation, and the previous one stops working immediately.

"Copiar" (Copy)

Copies the endpoint (URL), the newly generated key, or the example.

"Ver o guia passo a passo" (View the step-by-step guide)

Opens the orders integration guide in a new tab. It only appears when the dashboard is on the platform's address.

• "Receber pedidos" (Receive orders) card: your system pushes sales and feeds the RFV of the "Monitor de sucesso" (Success monitor).
• The order is accepted again without being duplicated when it arrives with the same external ID; it is matched to the contact by phone number or email.
• If the key does not load, the screen shows "Não foi possível carregar a sua chave de API" (Could not load your API key) and hides the generate button, so nobody accidentally replaces the key in use.

Screen states

Loading

Each tab shows gray blocks shaped like the content while the data arrives.

If something goes wrong

Each tab has its own failure message, always with the "Tentar de novo" (Try again) button; leads, notifications, and conversions keep working, only the screen did not load.

Opening banner

The explanation of the lead's path, which can be hidden.

Buttons and actions

"Entendi" (Got it)

Hides the opening banner. The dashboard remembers the choice for your user in this browser.

• Title "Receba leads de qualquer sistema e responda em segundos" (Receive leads from any system and reply in seconds).
• The lead's path in six steps: "Seu sistema" (Your system), "Entrada de leads" (Lead intake), "Primeiro contato" (First contact), "IA qualifica" (AI qualifies), "Rodízio" (Round-robin), and "Atendente" (Agent).

Your integrations

The grid with one card per integration and the numbers for the last 7 days.

Buttons and actions

"Ver entradas" (View entries)

Selects the integration and scrolls to the "Últimos leads recebidos" (Latest leads received) list.

"Editar" (Edit)Owner

Opens the integration wizard with the current data to change the name, source, legal basis, first contact, and destination. It does not appear on the internal integration.

"Mais" (More)Owner

Opens the integration menu. The up and down arrows move between items; Esc closes it and returns focus to the button.

"Pausar" (Pause)Owner

In the "Mais" (More) menu, pauses the integration: submissions from your system are rejected until you reactivate it. On the internal integration, orders enter the CRM with no first contact.

"Reativar" (Reactivate)Owner

In the "Mais" (More) menu, resumes accepting leads for the paused integration.

"Gerar nova chave" (Generate new key)Owner

In the "Mais" (More) menu, opens the confirmation to change the integration key.

"Excluir" (Delete)Owner

In the "Mais" (More) menu, opens the confirmation to delete the integration.

• Each card shows the name, the source, the creation date, and the "Ativa" (Active) or "Pausada" (Paused) badge.
• The key appears masked, with when it was last used or that it has not been used yet. An internal integration, created by the platform itself for a website form, appears as "Sem chave" (No key).
• Numbers for the last 7 days: "Recebidos" (Received), "Novos" (New), "Já existiam" (Already existed), and "Recusados" (Rejected) (in red when there are rejections).
• When the system sent the same lead again, the card shows how many repeated resends were ignored, at no cost.
• The first contact line says whether it is on, with the message template and who is charged for the send; stopped, with the reason in red; or off, when the AI only speaks after the lead writes.
• Clicking any part of the card that is not a button selects the integration and changes the detail shown below the grid.

Details of the selected integration

The detail header, with the integration name and its live status.

• Above the name, the "Receber leads por API" (Receive leads via API) tag (or the source form, on the internal integration).
• Live badge: "Recebendo" (Receiving), with the time of the last lead or no lead yet; or "Pausada" (Paused), submissions are rejected.

How to connect

Everything the person who maintains your system needs to send leads.

Fields and filters

"Endereço do envio" (Delivery URL)

The endpoint (URL) your system sends each lead to. It appears on the screen and in the documentation.

"Chave da integração" (Integration key)

The masked key, showing only the beginning and the end. It goes in the X-Api-Key header of each submission; the full key only appears when it is created.

"Exemplo de envio" (Sample request)

A ready-made example in three tabs: JSON, cURL, and the "Resposta" (Response) your system receives.

Buttons and actions

"Copiar endereço do envio" (Copy delivery URL)

Copies the submission endpoint (URL).

"Gerar nova" (Generate new)Owner

Opens the confirmation to generate a new key for this integration.

JSON

Shows the example of the lead body.

cURL

Shows the full call example, ready to test in the terminal.

"Resposta" (Response)

Shows what your system receives back when the lead is accepted.

"Copiar o exemplo" (Copy the example)

Copies the example from the open tab.

"Receber no formato do seu sistema" (Receive in your system's format)Owner

Opens the dialog to map the fields of your system's own format to the dashboard fields.

"Documentação completa" (Full documentation)

Opens the "API de entrada de leads" (Lead intake API) documentation.

• Warning "Use a chave só de servidor para servidor: nunca coloque a chave no código do site ou do aplicativo" (Use the key only from server to server: never put the key in the code of the website or the app).
• On the internal integration, in place of this card, "Como os pedidos chegam" (How orders arrive) appears, with the source page, the legal basis, and the message template used, with no key or API.

Latest leads received

The log of the integration's entries, which updates by itself.

Fields and filters

"Todos" (All)

Filter by status, with the count for each group: "Todos" (All), "Novos" (New), "Contatados" (Contacted), "Responderam" (Replied), and "Com problema" (With issues).

Buttons and actions

"Novos" (New)

Shows only the new leads.

"Contatados" (Contacted)

Shows the leads that received the first contact.

"Responderam" (Replied)

Shows the leads that replied to the first contact.

"Com problema" (With issues)

Shows the entries that were rejected, blocked, without balance, or with a sending failure.

"Carregar mais" (Load more)

Brings in the oldest entries in the list.

"Ver todas" (View all)

When a filter has no results, goes back to the "Todos" (All) filter.

"Reativar integração" (Reactivate integration)Owner

Appears when the integration is paused and nothing arrived in the last 7 days; reactivates the integration right there.

• Each row shows the lead's name (or "Entrada recusada" (Rejected entry)), the phone number, the trail of what happened, the reason when there is one, the status, and the time.
• The statuses are written in Portuguese and color-coded: "novo" (new), "agendado" (scheduled), "na fila" (in queue), "contatado" (contacted), "respondeu" (replied), "sem envio" (not sent), "bloqueado" (blocked), "não confirmado" (not confirmed), "falhou" (failed), "sem saldo" (no balance), and "recusado" (rejected).
• The test lead has the "Teste" (Test) badge.
• Rows that arrive while the screen is open appear highlighted and are announced to the screen reader.
• The footer says how many entries are in view out of the total for the last 7 days.

Entry drawer

Opens when you click a lead's name in the log and shows everything that arrived.

Buttons and actions

"Reenviar primeiro contato" (Resend first contact)

Appears when the submission can be repeated. Shows the confirmation with who is charged for the new send and, if the message may have already arrived, asks you to check the Inbox first.

"Reenviar agora" (Resend now)

Confirms the resend: the message goes out to the lead within seconds.

"Cancelar" (Cancel)

Cancels the resend.

"Abrir conversa" (Open conversation)

Opens the lead's conversation in the Inbox.

"Abrir ficha do lead" (Open lead record)

Opens the lead's record in the CRM.

"Entendi" (Got it)

Closes the drawer of a rejected entry.

• Badges for the result and the status; when there is a problem, a notice with the reason and what to do.
• "Origem" (Source): platform, campaign, ad set, ad, and the ID in your system.
• "Dados recebidos" (Data received): the extra fields the system sent; sensitive data appears hidden.
• "Base legal" (Legal basis): which one it was, where it came from, and the proof of consent, when there is one.
• "Linha do tempo" (Timeline): each step of the first contact, with the time.
• The rejected entry shows only the reason, the source, and the ID.

"Enviar lead de teste" (Send test lead)

Sends a real lead through the integration, marked as a test, and shows each step as it happens.

Fields and filters

"Seu celular" (Your mobile number)required

Appears with the switch on: the phone number with area code that receives the message the way the lead receives it.

Buttons and actions

"Mandar o primeiro contato para o meu WhatsApp" (Send the first contact to my WhatsApp)

Turns on sending the test's first contact to your mobile phone. It uses one send of the message template, with the template's cost when the account debits from the balance.

"Enviar lead de teste" (Send test lead)

Sends the test. After the first one, the button reads "Enviar outro teste" (Send another test).

• Steps tracked live: "Requisição recebida" (Request received), "Lead criado e marcado como teste" (Lead created and marked as test), "Primeiro contato enviado" (First contact sent), and "Entregue no seu WhatsApp" (Delivered to your WhatsApp).
• When the message does not go out, the step says "Nada foi cobrado" (Nothing was charged) and what is left to do.
• Below the steps appears the "Resposta da API" (API response), line by line.
• With the integration paused, the test warns that you must reactivate it first.
• Only appears for the Owner, and does not appear on the internal integration with no first contact.

"Primeiro contato automático" (Automatic first contact)

The summary of the integration's first contact, next to the log.

Buttons and actions

"Ajustar primeiro contato" (Adjust first contact)

Opens the "Primeiro contato automático" (Automatic first contact) screen for this integration.

• "Ligado" (On) or "Desligado" (Off) badge.
• Message template with name and category, "Custo" (Cost), "Horário" (Schedule), "Teto por dia" (Daily cap), "Teto do mês com modelos pagos" (Monthly cap with paid templates), and "Recontato" (Re-contact).
• Last 7 days: how many replied out of how many received the message, with the rate bar.

Default legal basis

Why you can contact the leads of this integration.

• Shows the basis chosen in the wizard and its summary; if the system sends the legal basis of each lead, the lead's own applies.
• With no default basis, "Sem base legal padrão" (No default legal basis) appears: each lead must bring the basis in the legal_basis field, or it is rejected.

"Nova integração" (New integration) dialog

The wizard in four steps: "Nome e origem" (Name and source), "Base legal" (Legal basis), "Primeiro contato" (First contact), and "Destino" (Destination). The same dialog opens as "Editar integração" (Edit integration).

Fields and filters

"Nome da integração" (Integration name)required

A name to recognize the integration later; only you and your team see it. Enter in the field moves to the next step.

"De onde vêm esses leads?" (Where do these leads come from?)

The source: "Anúncios da Meta" (Meta ads), "Outra plataforma de anúncios" (Other ad platform), "Formulário do site" (Website form), "Portal ou marketplace" (Portal or marketplace), or "Outro sistema" (Other system). Each choice shows an explanation.

"Por que você pode falar com essas pessoas?" (Why can you contact these people?)required

The legal basis: "Pediram para eu entrar em contato" (They asked me to contact them), which carries the note "Recomendado para anúncio" (Recommended for ads); "São meus clientes" (They are my customers); or "Já coletei o consentimento deles" (I have already collected their consent). The declaration is recorded with your name, the date, and the time on each lead.

"Conta do WhatsApp" (WhatsApp account)

The WhatsApp account that sends the first contact; only active accounts appear.

"Modelo aprovado" (Approved template)

The template approved by Meta used in the first message. A template with media in the header or without a confirmed price appears disabled, with the reason.

"Teto por dia" (Daily cap)

How many first messages this integration sends per day at most.

"Quadro do Funil" (Pipeline board)

The board where the lead's card is created; the default comes marked.

"Coluna de entrada" (Entry column)

The board column where the card is created.

"Etiquetas automáticas" (Automatic tags)

Tags that every lead from this integration gets. A suggestion based on the source is already filled in; Enter adds one, Backspace in the empty field removes the last.

Buttons and actions

"Anúncios da Meta" (Meta ads)

Chooses the "Anúncios da Meta" (Meta ads) source (the campaign, the ad set, and the ad come along).

"Outra plataforma de anúncios" (Other ad platform)

Chooses the source for ad forms from another platform.

"Formulário do site" (Website form)

Chooses the source for your website or launch page form.

"Portal ou marketplace" (Portal or marketplace)

Chooses the source for portals and marketplaces in your industry.

"Outro sistema" (Other system)

Chooses any other system that makes an HTTP call.

"Mandar a primeira mensagem sozinho pelo WhatsApp" (Send the first message automatically on WhatsApp)

In step 3, turns the automatic first contact on or off. It is locked with the "São meus clientes" (They are my customers) basis, with no connected WhatsApp account, or when it is not possible to confirm who pays for the send.

"Este sistema pode atualizar as etapas do funil" (This system can update pipeline stages)

In step 4, lets the integration key change the lead's stage, including sale and loss. A sale marked by the system also goes to the Meta conversions.

"Receber no formato do seu sistema" (Receive in your system's format)

In step 4, opens the custom format dialog; the format is saved with the integration.

"Voltar" (Back)

Goes back to the previous step.

"Continuar" (Continue)

Checks the step and moves on. With no name, no legal basis, or no template while first contact is on, it shows the error on the field.

"Criar integração" (Create integration)

In step 4, creates the integration and shows the "Integração criada" (Integration created) screen.

"Salvar alterações" (Save changes)

When editing, saves only what changed; it applies to the next leads, and the stage permission applies immediately.

"Copiar a chave" (Copy the key)

On the "Integração criada" (Integration created) screen, copies the key, which does not appear again.

"Copiar o endereço" (Copy the address)

On the "Integração criada" (Integration created) screen, copies the submission endpoint (URL).

"Enviar lead de teste" (Send test lead)

On the "Integração criada" (Integration created) screen, closes the wizard and immediately runs the integration test.

"Concluir" (Finish)

Closes the wizard and opens the details of the integration that was created.

• In step 3, the WhatsApp message preview and the cost strip: who is charged (the platform, debiting from the balance before each send, or Meta, directly on the WhatsApp account's card) and the maximum per day with the chosen cap.
• The sending schedule comes from the account and is adjusted later, on the "Primeiro contato automático" (Automatic first contact) screen.
• With the "São meus clientes" (They are my customers) basis, first contact stays off: a marketing message to a contract customer requires their consent.

"Receber no formato do seu sistema" (Receive in your system's format) dialog

Maps the fields of a real example from your system to the dashboard fields.

Fields and filters

"Exemplo do seu sistema" (Example from your system)

Paste a complete example of the JSON your system sends; the dialog already opens with an example and reads the fields.

"Campos encontrados" (Fields found)

One row per field in the example, with the choice of destination: "Não usar" (Don't use), "Nome" (Name), "Telefone" (Phone), "E-mail" (Email), "ID no seu sistema" (ID in your system), "Campanha de anúncio" (Ad campaign), "Conjunto" (Ad set), "Anúncio" (Ad), or "Dado recebido" (Data received).

Buttons and actions

"Encontrar campos" (Find fields)

Reads the pasted example and suggests the destination for each field.

"Salvar formato" (Save format)

Saves the format: the integration starts accepting one lead per submission in that format. It requires some field mapped to "Telefone" (Phone).

"Cancelar" (Cancel)

Closes without saving.

• This is how the lead would look: the preview with "Nome" (Name), "Telefone" (Phone), "E-mail" (Email), "ID no seu sistema" (ID in your system), "Origem" (Source), and the data received.
• With no phone mapped, a warning appears that the lead would be rejected.

"Gerar nova chave?" (Generate new key?) dialog

Confirms the change of the integration key and shows the new key only once.

Buttons and actions

"Gerar nova chave" (Generate new key)

Generates the new key; the current one stops working immediately.

"Copiar a chave nova" (Copy the new key)

Copies the new key to paste into your system.

"Já guardei a chave" (I've saved the key)

Closes the dialog and reminds you to change the key in your system.

"Cancelar" (Cancel)

Keeps the current key.

• Until the new key is changed in the system, its submissions are rejected; the leads that have already arrived remain in the dashboard.

"Excluir esta integração?" (Delete this integration?) dialog

Confirms deleting the integration.

Buttons and actions

"Excluir integração" (Delete integration)

Deletes it: the key stops working immediately. The leads and entries that have already arrived remain in the dashboard.

"Cancelar" (Cancel)

Cancels the deletion.

Screen states

Loading

Three gray cards in the grid and two detail blocks while the integrations arrive.

Nothing here yet

"Receba leads de qualquer sistema" (Receive leads from any system): the explanation, the "Nova integração" (New integration) button (Owner only), and the "Ver a documentação" (View the documentation) button. In the log, "Esperando o primeiro lead" (Waiting for the first lead) until the first one arrives.

If something goes wrong

"Não conseguimos carregar as integrações agora" (We couldn't load the integrations right now), with "Tentar de novo" (Try again); leads keep arriving normally.

Paused integration with nothing in the last 7 days

Nothing arrived in the last 7 days, with the "Reativar integração" (Reactivate integration) button.

Log filter with no results

"Nenhuma entrada com esta situação" (No entries with this status), with the "Ver todas" (View all) button.

First contact stopped

The integration card shows "Primeiro contato parado" (First contact stopped), in red, with the reason.

Breadcrumb and header

Where you are and the shortcut to the integration's log.

Buttons and actions

"Integrações" (Integrations)

In the breadcrumb, goes back to the "Entrada de leads" (Lead intake) tab.

"Ver entradas" (View entries)

Goes back to the "Entrada de leads" (Lead intake) tab with the integration chosen and scrolls to the log.

• Breadcrumb: "Integrações" (Integrations), "Entrada de leads" (Lead intake), and the integration name.
• Above the title, the integration name.

Insufficient balance notice

Appears when there are leads waiting for the first message because of insufficient balance.

Buttons and actions

"Recarregar saldo" (Top up balance)

Opens the "Carteira" (Wallet) to top up.

• "O primeiro contato parou: saldo insuficiente" (First contact stopped: insufficient balance), with how many leads are waiting. When you top up, the messages go out by themselves to those who arrived in the last 24 hours.

Numbers for the last 7 days

• "Enviados · 7 dias" (Sent · 7 days), with the change compared to the previous week.
• "Responderam" (Replied), with the percentage of contacted leads who replied and were taken over by the AI.
• "Até a mensagem" (Time to message): the typical time between the lead arriving and the message going out.
• "Gasto · 7 dias" (Spend · 7 days): what was charged during the week, or the notice that Meta charges on the WhatsApp account.

"Mandar a primeira mensagem sozinho" (Send the first message automatically)

The overall switch for this integration's first contact.

Buttons and actions

"Mandar a primeira mensagem sozinho" (Send the first message automatically)Owner

Turns automatic sending on or off. When off, the AI only speaks when the lead writes, and the settings below are dimmed.

• On the internal integration with no first contact, the sentence says that the sales team is the one who reaches out, and the switch is locked.
• With no WhatsApp account connected, the notice appears with the link to "Conexões" (Connections).

Account and template

The WhatsApp account and the message templates approved by Meta on this account.

Fields and filters

"Conta do WhatsApp" (WhatsApp account)

The account that sends; the list shows when it is the default and when it is your own account (Meta charges directly). Switching accounts refreshes its templates.

"Modelo aprovado" (Approved template)

One card per template, with title, technical name, category, the text, and who is charged. A template that cannot go out as the first contact appears dimmed, with the reason.

Buttons and actions

"Atualizar" (Refresh)

Fetches the list of templates approved on Meta again.

"Criar modelo" (Create template)

Opens the creation of a message template, when the account has none approved.

"Atualizar lista" (Refresh list)

Fetches the templates again, on the empty list.

"Tentar de novo" (Try again)

Retries the template refresh when it failed; first contact continues with the chosen template.

• "Lista atualizada com a Meta" (List updated with Meta) line, with how long ago.
• When the chosen template was paused or deleted on Meta, "O primeiro contato parou" (First contact stopped) appears, with the reason.
• On the internal integration, the card only shows the account, the template, and what goes in each placeholder, with a badge saying they are set by the form: they cannot be changed on this screen.

What goes in each message placeholder

Appears when the template has variables: each numbered placeholder becomes a piece of lead data.

Fields and filters

"Preencher ‹n› com" (Fill ‹n› with)

The data that goes in the placeholder: "Primeiro nome" (First name), "Nome completo" (Full name), "Nome da empresa" (Company name), "Nome da persona" (Persona name), "Nome da campanha de anúncio" (Ad campaign name), or "Campo recebido" (Received field).

"Se faltar, usar" (If missing, use)

The text used when the lead does not have the data. If left blank, the message does not go out to anyone without the data, and the reason is recorded in the log.

"Nome do campo recebido" (Received field name)

With "Campo recebido" (Received field), the key your system sends inside fields.

• With the campaign name, a warning reminds you that the lead sees that text: use it only if it is presentable.

Sending rules

So the message arrives at the right time, to the right person, without wasting money.

Fields and filters

"Das" (From)

The sending start hour, from 5h to 14h.

"às" (to)

The sending end hour, from 16h to 23h. The account's time zone appears next to it.

"Teto por dia" (Daily cap)

Messages per day on this integration, from 1 to 5,000. Once the cap is passed, the rest goes out the next day and you get a notice.

Buttons and actions

"‹n› dias" (‹n› days)

Chooses for how many days the same person does not receive another first message: 15, 30, 60, or 90 days, from any integration.

"Diminuir o teto em 50" (Decrease the cap by 50)

Lowers the daily cap by 50.

"Aumentar o teto em 50" (Increase the cap by 50)

Raises the daily cap by 50.

"Ajustar" (Adjust)

Opens the billing section of "Configurações" (Settings), where the monthly cap is.

• Only for those who have a legal basis and "Nunca interrompe o seu time" (Never interrupts your team): rules with the "Sempre ligada" (Always on) badge.
• The 24-hour bar shows the chosen schedule and the current time; the sentence below says whether a lead who arrives now receives the message within seconds or at what time.
• "Teto do mês com modelos pagos" (Monthly cap with paid templates): applies to the whole account, adding up first contacts and cadences, with a bar showing how much has been used.
• Warning that marketing messages in high volume can lower the number's quality on Meta.

How the lead receives it

The message preview on WhatsApp with a sample lead.

Buttons and actions

"Lead sem nome" (Lead without a name)

Switches the preview to a sample lead with no name, to see the text for when the data is missing.

"Ver a IA assumir a conversa" (Watch the AI take over the conversation)

Simulates the lead replying and the AI taking over the conversation. The reply shown is illustrative. Afterward it becomes "Recomeçar a prévia" (Restart the preview).

• The bubble with the placeholders already filled in and the template buttons.
• With first contact off, the preview is covered by the "Primeiro contato desligado" (First contact off) notice.
• When the message would not go out for the sample lead, the warning appears with the missing data.

Cost per send

The template's price on this account and how much the balance covers.

Fields and filters

"Leads por mês" (Leads per month)

A slider to simulate the month's volume; it opens near what arrived last month through this integration.

• The amount per lead, debited before each send; if Meta rejects it right away, the amount returns to the balance.
• Monthly estimate and the maximum per day with the chosen cap.
• Current balance and for about how many days it lasts at the estimated pace, counting the month's included allowance.
• On your own WhatsApp account, the card says there is no platform cost: Meta charges according to its own price list.

Unsaved changes bar

Appears pinned to the bottom of the screen when something has changed.

Buttons and actions

"Salvar" (Save)Owner

Saves the first contact; it applies to the next leads of this integration.

"Descartar" (Discard)Owner

Goes back to what was saved.

Screen states

Loading

Gray numbers and cards with the integration name still blank.

If something goes wrong

"Não conseguimos carregar o primeiro contato agora" (We couldn't load the first contact right now), with "Tentar de novo" (Try again); leads keep receiving the message normally.

The integration was deleted

"Esta integração não existe mais" (This integration no longer exists), with the "Ver integrações" (View integrations) button.

The account has no approved template

"Nenhum modelo aprovado nesta conta" (No approved template on this account), with "Criar modelo" (Create template) and "Atualizar lista" (Refresh list).

The person opening it is an Admin

Everything appears, but the switch and the settings are locked and the save bar does not appear.

Top of the documentation

Buttons and actions

"Enviar o primeiro lead" (Send the first lead)

Jumps to the "Enviar leads" (Send leads) section.

"Ver os campos" (View fields)

Jumps to the "Campos do lead" (Lead fields) section.

• Badge "Documentação da API · versão 1" (API documentation · version 1), the update date, and the badges "Chave por integração" (Key per integration), JSON · UTF-8, and "Mensagens em português" (Messages in Portuguese).
• An example of a sent lead being typed out live, with the lead-created response.
• The API endpoint (URL) is your account's own and appears in the examples on the screen itself.

"Nesta página" (On this page)

The table of contents that follows your reading, with a progress bar at the top.

Buttons and actions

"Voltar ao topo" (Back to top)

Goes back to the top of the documentation.

• "Começando" (Getting started): "Visão geral" (Overview), "Autenticação" (Authentication), and "Enviar leads" (Send leads).
• "Referência" (Reference): "Campos do lead" (Lead fields), "Origem do anúncio" (Ad source), "Base legal (LGPD)" (Legal basis (LGPD)), "Primeiro contato" (First contact), "Resposta" (Response), "Erros" (Errors), "Motivos de recusa" (Rejection reasons), and "Atualizar a etapa" (Update the stage).
• "Boas práticas" (Best practices): "Repetidos e reenvio" (Duplicates and resending), "Limites" (Limits), "Formato do seu sistema" (Your system's format), and "Depois que o lead entra" (After the lead enters).
• On a narrow screen, the table of contents becomes a list that opens and closes.
• Each section title has a button that copies the direct link to it.

Code examples

Buttons and actions

cURL

Shows the submission in cURL.

JavaScript

Shows the submission in JavaScript.

Python

Shows the submission in Python.

PHP

Shows the submission in PHP.

"Tudo certo" (All good)

Shows the response for when the lead was accepted.

"Com recusa" (Rejected)

Shows the response with a rejected lead and the reason.

"Chave inválida" (Invalid key)

Shows the invalid key response.

"Muitas chamadas" (Too many requests)

Shows the response for when the system makes too many calls.

"Copiar o endereço" (Copy the address)

Copies the submission endpoint (URL).

"Copiar os cabeçalhos" (Copy the headers)

Copies the authentication headers.

"Copiar o exemplo" (Copy the example)

Copies the example in the open language.

"Copiar o lead completo" (Copy the full lead)

Copies the lead example with all the fields.

"Copiar a resposta" (Copy the response)

Copies the open response.

"Copiar o exemplo de atualizar a etapa" (Copy the update-stage example)

Copies the example of a stage change made by your system.

Was this page helpful?

Fields and filters

"O que faltou?" (What was missing?)

After "Não" (No), a field to tell what you were looking for and did not find.

Buttons and actions

"Sim" (Yes)

Records that the page was helpful.

"Não" (No)

Opens the "O que faltou?" (What was missing?) field.

"Enviar" (Send)

Sends the comment; the team reads every message.

"Abrir Integrações no painel" (Open Integrations in the dashboard)

At the end of the page, goes back to the "Entrada de leads" (Lead intake) tab.

Top of the documentation

Buttons and actions

"Conferir a assinatura" (Verify the signature)

Jumps to the section that explains how to verify the notification's signature.

"Ver os eventos" (View events)

Jumps to the list of events.

• Badge "Documentação dos webhooks · versão 1" (Webhooks documentation · version 1), the update date, and the badges for events, JSON · UTF-8, and signature.
• An example of a qualified lead notification arriving at your system.

"Nesta página" (On this page)

Buttons and actions

"Voltar ao topo" (Back to top)

Goes back to the top of the documentation.

Node.js

Shows the signature verification in Node.js.

• "Começando" (Getting started): "Visão geral" (Overview), "Receber um aviso" (Receive a notification), and "Conferir a assinatura" (Verify the signature).
• "Referência" (Reference): Envelope, "Os 13 eventos" (The 13 events), "Dados pessoais" (Personal data), and "Cabeçalhos" (Headers).
• "Boas práticas" (Best practices): "Novas tentativas" (Retries), "Pausa automática" (Automatic pause), "Ordem e duplicidade" (Order and duplicates), "Evento de teste" (Test event), and "Registro de entregas" (Delivery log).
• Examples of signature verification in Node.js, Python, and PHP.

End of the page

Buttons and actions

"Sim" (Yes)

Records that the page was helpful.

"Não" (No)

Opens the "O que faltou?" (What was missing?) field.

"Abrir Webhooks no painel" (Open Webhooks in the dashboard)

Goes back to the Webhooks tab of "Integrações" (Integrations).

Shortcut to inbound webhooks

Appears only with the "Base avançada" (Advanced base) module active.

• "Webhooks de entrada" (Inbound webhooks) card · in the "Base avançada" (Advanced base): takes you to the notifications your system sends to the dashboard, with "when X arrives, do Y" rules.

Webhook numbers

• "Entregues · 7 dias" (Delivered · 7 days), with the change compared to last week.
• Delivery rate for the last 7 days' deliveries; when part of the failures came from an endpoint (URL) that is already paused, the sentence says how many.
• Average response time of the receiving systems.
• "Tentando de novo" (Retrying), with the time of the next attempt or none in the queue.

Webhook card

One card per registered endpoint (URL).

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 notifications; failures are resent from the delivery log.

"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. With the webhook paused, it is disabled with the tip "Ative o webhook para testar" (Activate the webhook to test).

"Editar webhook ‹endereço›" (Edit webhook ‹URL›)

Pencil button: opens the webhook's edit form.

"Excluir webhook ‹endereço›" (Delete webhook ‹URL›)

Trash can button: opens the delete confirmation.

"Ver na lista de entregas" (View in the deliveries list)

On the test result, opens the deliveries drawer.

• The endpoint (URL) split into domain and path.
• Badge "Ativo" (Active), "Pausado" (Paused), or "Pausado automaticamente" (Paused automatically); badge "Com dados pessoais" (With personal data) or "Sem dados pessoais" (Without personal data); who created it and when.
• The events the endpoint (URL) receives, as tags; those beyond five go into a +N with the list on hover.
• Health over the last 7 days: the percentage delivered, the failures, the last send with "Entregue" (Delivered), "Não entregue" (Not delivered), "Tentando de novo" (Retrying), or "Nunca disparado" (Never fired), and the bar (red when more fail than are delivered).
• The test result appears on the card itself: "Enviando o teste" (Sending the test), "Entregue" (Delivered) with the time, "Não entregue" (Not delivered) with the reason, or "Aguardando" (Pending).

For whoever will program the receiving

The card to show to the team that maintains your CRM.

Buttons and actions

"Documentação dos webhooks" (Webhooks documentation)

Opens the full documentation for outbound webhooks.

"Copiar os cabeçalhos de cada aviso" (Copy the headers of each notification)

Copies the headers example.

• How to know the notification is yours: read the headers X-Webhook-Timestamp and X-Webhook-Signature-V2, calculate the signature with the secret and compare, and use X-Webhook-Id so the same notification is not processed twice.
• Headers of each notification, as an example.
• If your system does not respond: the trail of retries, until the platform stops; a success response counts as delivered.
• After many notifications in a row without success, the webhook is paused and you are notified by email and in the bell; everything stays in the log with the "Reenviar" (Resend) button.

"Novo webhook" (New webhook) dialog

Say where to send and what to notify; the same dialog opens as "Editar webhook" (Edit webhook).

Fields and filters

"Endereço que vai receber" (URL that will receive)required

The secure endpoint (URL), over https, that your system reserved for notifications. An endpoint without https, invalid, or on an internal network is rejected with an explanation.

"O que avisar" (What to notify)required

The events in groups (Leads, "Funil" (Pipeline), "Atendimento" (Service), and "Pedidos" (Orders)), with the count of selected ones. A new webhook comes with "lead criado" (lead created), "qualificado" (qualified), "atribuído" (assigned), "mudou de etapa" (changed stage), "venda" (sale), and "perdido" (lost) already selected.

"Segredo de assinatura" (Signing secret)

When editing, the masked secret. It only appears in full once, when the webhook is created.

Buttons and actions

"Marcar todos" (Select all)

Selects all the events in the group; with the whole group selected, it becomes "Desmarcar" (Clear all).

"Enviar dados pessoais" (Send personal data)

When it appears, turns on sending name, phone, email, and conversation summary to this endpoint (URL), after a confirmation. Turning it off is immediate.

"Gerar segredo novo" (Generate new secret)

When editing, asks for confirmation and generates a new secret; the current one stops being valid immediately.

"Manter o atual" (Keep current)

Cancels generating the new secret.

"Excluir" (Delete)

When editing, opens the delete confirmation.

"Cancelar" (Cancel)

Closes without saving.

"Criar webhook" (Create webhook)

Creates the webhook and shows the "Webhook criado" (Webhook created) screen, with the signing secret.

"Salvar alterações" (Save changes)

Saves; the changes apply from the next notification.

"Copiar o segredo de assinatura" (Copy the signing secret)

On the "Webhook criado" (Webhook created) screen, copies the secret, which does not appear again.

"Enviar evento de teste" (Send test event)

On the "Webhook criado" (Webhook created) screen, opens the webhook test.

"Concluir" (Finish)

Closes it and moves focus to the "Testar" (Test) button on the new card.

• Each event has a name in Portuguese and a description: "Lead criado" (Lead created), "Lead qualificado" (Qualified lead), "Lead quente" (Hot lead), "Pediu para não receber mensagens" (Asked not to receive messages), "Dados apagados (LGPD)" (Data erased (LGPD)), "Mudou de etapa" (Changed stage), "Venda (ganho)" (Sale (won)), "Perdido" (Lost), "Negócio reaberto" (Deal reopened), "Atribuído a um atendente" (Assigned to an agent), "Transbordo para humano" (Handoff to a human), "Primeiro contato" (First contact) and "Pedidos importados" (Orders imported).
• Without the personal data switch, the form warns that the system receives only identifiers: lead ID, stage, score, values, and deal fields that are not sensitive.
• Each notification is signed in the X-Webhook-Signature-V2 header.

Dialog "Ligar dados pessoais?" (Turn on personal data?)

The confirmation before turning on personal data on a webhook.

Buttons and actions

"Manter desligado" (Keep off)

Closes without turning it on.

"Ligar dados pessoais" (Turn on personal data)

Turns it on for this webhook only; the change is recorded in the audit log with who turned it on and when.

• Shows what will go out in the "Lead qualificado" (Qualified lead) notification, with the new lines highlighted.

Dialog "Enviar evento de teste" (Send test event)

Sends a sample with fictitious data to the endpoint (URL).

Fields and filters

"Evento" (Event)

Only the events the webhook receives, in groups, with the description of the one selected.

Buttons and actions

"Copiar corpo" (Copy body)

Copies the body of the sample that will be sent.

"Enviar teste" (Send test)

Sends the sample; the result appears on the card within a few seconds.

"Cancelar" (Cancel)

Closes without sending.

Dialog "Excluir este webhook?" (Delete this webhook?)

Buttons and actions

"Excluir webhook" (Delete webhook)

Deletes it: the endpoint (URL) stops receiving notifications immediately and its delivery log is deleted along with it.

"Cancelar" (Cancel)

Cancels the deletion; focus moves to this button.

Drawer "Entregas do webhook" (Webhook deliveries)

The deliveries of a webhook, without leaving the tab.

Buttons and actions

"Todas" (All)

Shows all of the webhook's deliveries.

"Entregues" (Delivered)

Shows only the delivered ones.

"Falharam" (Failed)

Shows only the ones that failed.

"Reenviar" (Resend)

Resends the open delivery with the same event ID, so your system does not duplicate it.

"Abrir o registro completo" (Open full record)

Opens the "Entregas" (Deliveries) tab already filtered on this webhook.

• Each delivery opens with the response, the error, and the body sent, with the "Copiar corpo" (Copy body) button.
• The "Atualiza sozinho" (Updates automatically) badge while the list follows the deliveries.

"Entregas" (Deliveries) tab: "Registro de entregas" (Delivery log)

Everything that was sent to your systems in the last 30 days.

Fields and filters

"Filtrar por webhook" (Filter by webhook)

All webhooks or a single endpoint (URL).

"Filtrar por evento" (Filter by event)

All events or a single event, in groups.

"Buscar por lead ou ID do evento" (Search by lead or event ID)

Searches by lead name or event ID.

Buttons and actions

"Todas" (All)

Shows all deliveries, with the total.

"Entregues" (Delivered)

Shows the delivered ones.

"Falharam" (Failed)

Shows the ones that failed.

"Ver só esse endereço" (View only this address)

Filters the list to the paused endpoint (URL) that caused the failures.

"Corpo enviado" (Body sent)

Shows the body that was sent.

"Resposta" (Response)

Shows the beginning of your system's response.

"Cabeçalhos" (Headers)

Shows the headers that were sent.

"Reenviar" (Resend)

Resends with the same event ID. On a paused webhook, it first asks for "Reativar e reenviar" (Reactivate and resend).

"Reativar e reenviar" (Reactivate and resend)

Reactivates the paused webhook and resends the delivery.

"Copiar corpo" (Copy body)

Copies the body that was sent so you can test it in your system.

"Limpar filtros" (Clear filters)

On an empty filter result, clears all filters.

"Carregar mais antigas" (Load older)

Loads older deliveries.

"Ir para os webhooks" (Go to webhooks)

On the empty log, returns to the "Webhooks" tab.

• "Saúde · últimos 7 dias" (Health · last 7 days): the rate in large type, "Entregues" (Delivered), "Falharam" (Failed), "Tentando de novo" (Retrying), and "Resposta média" (Average response).
• Deliveries-per-day chart: each bar is a button that shows the day, the deliveries, the failures with the reason, and the pauses.
• List grouped by day, most recent first, in Brasília time. Each row shows the event, the lead, the time, the summary, the endpoint (URL), the attempt, and the status: "Entregue" (Delivered), "Tentando de novo" (Retrying), "Não entregue" (Not delivered), or "Na fila" (In queue).
• When you open a delivery: the notification, each attempt with its code and time, and the "Corpo enviado" (Body sent), "Resposta" (Response), and "Cabeçalhos" (Headers) tabs.

Screen states

Loading

Gray numbers and cards while the webhooks and the log load.

Nothing here yet

No webhooks yet, with "Novo webhook" (New webhook) and "Ver como funciona" (See how it works). In the log, "Nenhuma entrega ainda" (No deliveries yet), with "Ir para os webhooks" (Go to webhooks).

If something goes wrong

"Não conseguimos carregar os seus webhooks agora" (We couldn't load your webhooks right now) (or the log), with "Tentar de novo" (Try again); notifications keep going out normally.

The person opening it is not the account Owner

Webhooks belong to the account Owner: only the Owner creates, changes, and monitors notifications. This applies to the "Webhooks" and "Entregas" (Deliveries) tabs.

The webhook was paused automatically

The card shows the "Pausado automaticamente" (Paused automatically) badge, and the notice shows "Reativar" (Reactivate) and "Ver as falhas" (View failures).

Log filter with no results

"Nenhuma entrega com estes filtros" (No deliveries with these filters), with "Limpar filtros" (Clear filters).

Header and "Enviar conversões" (Send conversions)

The explanation, the path from ad to sale, and the master control for sending.

Buttons and actions

"Enviar conversões" (Send conversions)Owner

Switch that turns sending of all stages to Meta on or off. It only turns on after the connection has been checked.

• Title "Ensine seus anúncios a trazer quem compra, não só quem clica." (Teach your ads to bring in buyers, not just clickers.)
• The path "Anúncio" (Ad), "Lead qualificado" (Qualified lead), "Etapas do quadro" (Board stages), and "Venda" (Sale), with the loop back to the campaign.
• "Enviadas · 7 dias" (Sent · 7 days) and "Casadas" (Matched) (the percentage matched by the ad's form ID).
• The status sentence: on since when and by whom, off, ready to turn on, or stopped until the token is replaced, with how many conversions are waiting.
• Badge "Enviando em tempo real" (Sending in real time), "Envio desligado" (Sending off), or "Parado até trocar o token" (Stopped until the token is replaced).

Rejected token banner

Appears at the top when Meta rejected the token or when the token needs to be pasted again.

Buttons and actions

"Trocar token" (Change token)Owner

Goes to step 1 and opens the token field.

• Says how many conversions are waiting; they go out on their own when the token is replaced. For anyone who is not the Owner, it asks the Owner to replace it.

Step 1: Connect to your dataset

You generate the token in your Meta account and paste it here along with the test code; no password or access to the ad account is requested.

Fields and filters

"ID do conjunto de dados" (Dataset ID)required

Numbers only; in Events Manager, the number under Identification, below the dataset name.

"Token de acesso" (Access token)required

Paste the token; once saved, it is never shown in full again.

"Código de teste" (Test code)required

The TEST code from the Test events tab, Website channel; the check sends a test event with it.

Buttons and actions

"Mostrar token" (Show token)Owner

Shows the token you typed; it becomes "Ocultar token" (Hide token).

"Conferir conexão" (Check connection)Owner

Sends a test event to Meta and saves the connection when it is accepted.

"Trocar token" (Change token)Owner

Opens the form to paste a new token.

"Conferir de novo" (Check again)Owner

Checks the already saved connection again.

"Cancelar" (Cancel)Owner

Closes the token replacement without changing anything.

• Step badge: "Conectado" (Connected), "Falta conectar" (Not connected yet), "Token recusado" (Token rejected), or "Cole o token de novo" (Paste the token again).
• When connected, it shows the "Conjunto de dados" (Dataset), the "Token de acesso" (Access token) stored securely, and the "Última conferência" (Last check).
• Where to generate the token: three illustrated steps in Events Manager.

Step 2: Choose what to send

Each board stage becomes an event on Meta; the win goes with the deal value. Unlocked after the connection has been checked.

Fields and filters

"Quadro" (Board)

The "Funil" (Pipeline) board whose stages become events; each column declares its role in the pipeline.

Buttons and actions

"Evento na Meta:" (Event in Meta:)Owner

Each row has the stage, the role, the event on Meta, and a switch that turns that stage on or off; the change is saved immediately and shows "Salvo" (Saved).

"Abrir o Funil" (Open Pipeline)

When there is no board, it opens the "Funil" (Pipeline) so you can create one.

• Badge showing how many of the available stages are turned on.
• The entry column and the lost column do not become events; a win goes out as "Compra" (Purchase), with the deal value.
• In health industries, conversions are not sent yet, and the rows show "Não sai neste segmento" (Not sent in this industry).

Step 3: Test

Send a test event and check in the test tab of Events Manager that it arrived.

Fields and filters

"Código de teste" (Test code)

The code from the test tab; without it, the event would count as a real one.

"Evento" (Event)

Which turned-on stage goes in the test.

Buttons and actions

"Enviar evento de teste" (Send test event)Owner

Sends the test event with a made-up identifier that does not match any of your customers.

"Ver o que sai no evento de teste" (See what is sent in the test event)

Shows the body sent to Meta.

Match quality

How each conversion was linked to a person on Meta.

Buttons and actions

"7 dias" (7 days)

Shows the 7-day period.

"30 dias" (30 days)

Shows the 30-day period.

• "Enviadas" (Sent), "Aguardando" (Pending), "Recusadas" (Rejected), and "Puladas" (Skipped).
• The bar split between "ID do formulário" (Form ID) and "Telefone e e-mail criptografados" (Encrypted phone and email).
• "Por etapa" (By stage): how many of each stage were sent.
• The quality score that Meta calculates lives in Events Manager; the screen does not make up that number.

"Registro de envios" (Send log)

Each conversion that was sent, is in the queue, or was skipped, with the reason.

Buttons and actions

"Todos" (All)

Shows all sends.

"Enviados" (Sent)

Shows the ones sent.

"Aguardando" (Pending)

Shows the ones waiting.

"Recusados" (Rejected)

Shows the ones rejected by Meta.

"Pulados" (Skipped)

Shows the skipped ones, with the reason.

"Reenviar" (Resend)Owner

Resends the rejected conversion with the same ID, without duplicating it.

"Mostrar mais" (Show more)

Loads more rows from the log.

• Columns "Quando" (When), "Lead", "Evento" (Event), "Casamento" (Match), "Situação" (Status), "Tentativas" (Attempts), and "Ação" (Action), in Brasília time.
• A sale marked by your system appears as "Marcada pelo seu sistema" (Marked by your system).

What goes to Meta, and what never does

Buttons and actions

"Política de privacidade" (Privacy policy)

Opens the privacy policy.

• Sent: the stage reached and the time, the sale value, the ad's form ID and, without it, encrypted phone and email.
• Never sent: the lead's name, the conversation and the AI summary, phone or email in plain text, the deal fields, and nothing about anyone who asked not to receive messages or had their data deleted.
• Meta does not charge for these sends, and your balance is not touched.

Screen states

Loading

Gray blocks for the header and the three steps.

Nothing here yet

No conversions sent yet: appears in place of the log until you connect and turn on sending.

If something goes wrong

"Não conseguimos carregar as conversões agora" (We couldn't load the conversions right now), with "Tentar de novo" (Try again); sending to Meta keeps working.

First time, no connection

Steps 2 and 3 stay locked with "Liberado depois que a conexão for conferida" (Unlocked after the connection is checked).

The person opening it is not the Owner

Only the account Owner connects, turns on sending, and sends the test; the fields and switches appear locked.

The account does not have the feature yet

Conversions are not available on this account yet.