# Meta Conversions API

## Meta Conversions API

O módulo **Meta Conversions API** ajuda você a registrar conversões que acontecem durante a conversa (como compra, lead ou avaliação) e enviar essas informações para a Meta. Isso melhora a atribuição e a otimização das campanhas.

<figure><img src="/files/DlM8VJbZ309slGVUWoOS" alt=""><figcaption><p>Imagem 1 -  Visão geral do construtor com o módulo Meta Conversions API selecionado</p></figcaption></figure>

### Como acessar

1. No menu lateral, clique em **Bot**.
2. Acesse **Fluxos**.
3. Abra um fluxo existente ou crie um novo.
4. No construtor, localize o módulo **Meta Conversions API** na lista de módulos.
5. Arraste o módulo para o diagrama e abra a configuração.

<figure><img src="/files/jPTibt5wrUtnx1ONOmC3" alt=""><figcaption><p>Imagem 2 - Caminho para acessar a API de conversão Meta.</p></figcaption></figure>

{% hint style="info" %}
Se você estiver conhecendo o construtor agora, vale revisar primeiro a tela de gerenciamento de fluxos no módulo Fluxos e depois voltar para concluir a configuração deste módulo.
{% endhint %}

#### Conhecendo a tela

#### <sub>Cabeçalho do módulo</sub>

No topo da janela, você vê o nome do módulo e etiquetas dos canais suportados (**WhatsApp**, **Instagram** e **Messenger**). Logo abaixo, há uma explicação curta sobre o envio de conversões.

#### <sub>Bloco de orientação</sub>

Você encontra um bloco informativo explicando, em passos simples, como a conversão acontece desde o clique no anúncio até o envio do evento.

* Esse bloco ajuda a validar se você está configurando o módulo no momento certo do fluxo.
* Também existe um link para a documentação oficial da Meta, abrindo em nova guia.

#### <sub>Evento de conversão</sub>

Aqui você escolhe qual tipo de evento será enviado. A lista vem organizada por grupos para facilitar a seleção.

| Campo               | O que preencher                                                                                                            |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Evento de conversão | Selecione a ação que aconteceu na conversa (ex.: compra, início de checkout, pedido entregue, lead qualificado, avaliação) |

**Dados customizados (JSON)**

Nesta área, você informa os dados que acompanham o evento, como valor, moeda e outros detalhes relevantes.

| Campo              | O que preencher                                                                                                        |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| Dados customizados | Estruture os dados da conversão no formato esperado, incluindo valores importantes para a análise (ex.: moeda e valor) |
| Exemplo            | Geração automática de exemplos do payload para o evento selecionado.                                                   |

#### <sub>Saídas no diagrama (OK e ERRO)</sub>

No cartão do módulo dentro do diagrama, existem duas saídas:

* **OK**: segue para o próximo passo quando o envio funciona.
* **ERRO**: segue para um caminho de tratamento quando o envio falha.

#### <sub>Ações principais</sub>

1️⃣ **Selecionar o evento de conversão**

**🎯 Propósito**\
Definir exatamente qual ação do cliente será enviada para a Meta.

**✅ Como fazer na tela**

1. Abra o módulo **Meta Conversions API** no diagrama.
2. No campo **Evento de conversão**, clique para abrir a lista.
3. Escolha o evento que representa a ação do cliente.

**📌 Resultado esperado**\
O evento escolhido fica visível no módulo e será usado no envio da conversão.

2️⃣ **Gerar um exemplo automático de dados**

**🎯 Propósito**\
Preencher rapidamente uma estrutura inicial de dados para acelerar a configuração.

**✅ Como fazer na tela**

1. Primeiro selecione um **Evento de conversão**.
2. Clique no botão **Exemplo** ao lado de **Dados personalizados**.
3. Ajuste os valores exibidos conforme a necessidade do seu fluxo.

**📌 Resultado esperado**\
O editor recebe um modelo pronto de dados, que você pode adaptar antes de salvar.

3️⃣ **Configurar e salvar dados personalizados**

**🎯 Propósito**\
Garantir que o evento seja enviado com os detalhes corretos da conversão.

**✅ Como fazer na tela**

1. No editor **Dados personalizados**, informe os dados da conversão.
2. Quando necessário, use variáveis do fluxo para preencher valores dinâmicos.
3. Revise as informações e salve a configuração do módulo.

**📌 Resultado esperado**\
O módulo fica pronto para enviar o evento com os dados definidos por você.

4️⃣ **Tratar sucesso e falha no fluxo**

**🎯 Propósito**\
Controlar o que acontece após o envio da conversão, tanto em caso de sucesso quanto de erro.

**✅ Como fazer na tela**

1. No diagrama, conecte a saída **OK** para o próximo passo desejado.
2. Conecte a saída **ERRO** para um caminho de tratamento (ex.: aviso interno ou nova tentativa).
3. Teste o fluxo para validar os dois caminhos.

**📌 Resultado esperado**\
O fluxo continua de forma previsivel, com caminho definido para sucesso e para falha.

#### Antes de usar o módulo **Meta Conversions API**, é necessário que o identificador do conjunto de dados esteja disponível para o número de WhatsApp conectado.

1. O que precisa existir antes: canal de WhatsApp configurado e apto para uso.
2. Onde configurar: **Canais > WhatsApp > Número > Conversions API**.
3. Como voltar para concluir: após validar a configuração do canal, retorne para **Bot > Fluxos**, abra o fluxo e finalize o módulo.

<figure><img src="/files/MPmIljgwrQ8pM87FdpRs" alt=""><figcaption><p>Imagem 3 - API de conversões no Canal do WhatsApp.</p></figcaption></figure>

### Dicas úteis

* Escolha sempre o evento que mais representa a ação real do cliente na conversa.
* Para eventos com valor financeiro, revise moeda e valor antes de salvar.
* Use o botão **Exemplo** como ponto de partida, depois adapte para sua realidade.
* Conecte sempre as duas saídas do módulo para evitar fluxo sem tratamento de erro.

### Resumo

* O módulo **Meta Conversions API** envia eventos de conversão da conversa para a Meta.
* Você define o tipo de evento e os dados personalizados em uma única configuração.
* O botão **Exemplo** acelera o preenchimento inicial dos dados.
* As saídas **OK** e **ERRO** permitem controlar o próximo passo do fluxo com segurança.
* Com os pré-requisitos do canal em dia, a configuração fica simples e pronta para operação.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/meta-conversions-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.