> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/integracao/evento.md).

# Evento

O módulo **Evento** registra um evento personalizado durante o fluxo, permitindo monitorar e automatizar operações em tempo real com base em dados definidos por você.

{% hint style="info" %}
Antes de usar este módulo, o evento precisa ser **cadastrado previamente** na tela **Eventos**, onde você define o nome, a descrição e os campos personalizados (texto, número, data, seleção ou verdadeiro/falso) que fazem parte dele.
{% endhint %}

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FJHYza30tyQF4gT0Cooxq%2F01-visao-geral-canvas.png?alt=media&amp;token=ec7afd78-563a-4a63-86d8-1b64afd3bf76" alt=""><figcaption><p>Imagem 1 - Visão geral do módulo Evento na área de trabalho do fluxo no Hyperflow Integrações.</p></figcaption></figure>

***

### 🧭 Como acessar

1. No menu lateral, clique em **Gerenciamento de aplicativos**.
2. Em seguida, clique em **Fluxos**.
3. Abra ou crie um fluxo e acesse a área de trabalho do fluxo.
4. No painel de módulos, localize a categoria **Integração** (identificada pela cor azul).
5. Arraste o módulo **Evento** para a área de trabalho do fluxo.

{% hint style="warning" %}
**Antes de usar este módulo:** é necessário ter o recurso de **Analytics** habilitado no seu ambiente, além de ter pelo menos um evento já cadastrado na tela **Eventos**.
{% endhint %}

***

### 🔍 Conhecendo o módulo

Ao clicar duas vezes no módulo na área de trabalho do fluxo, um painel de configuração é aberto na lateral da tela.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2F3FBq2LidhEBTv8dFm6JA%2F02-painel-aberto.png?alt=media&amp;token=b6f77703-2bce-4a9b-b818-e411d6bc559b" alt=""><figcaption><p>Imagem 2 - Painel de configuração do módulo Evento aberto.</p></figcaption></figure>

***

#### 🏷️ Evento

Selecione o evento já cadastrado que deseja registrar. Ao selecionar, o nome e a descrição do evento são exibidos, junto com um link para ver os detalhes do evento na tela de cadastro.

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FfHfwjbYIrioqicuBVTYz%2F03-lista-eventos.png?alt=media&amp;token=9d32782e-2bd8-4138-bd28-cdd0a32b8d37" alt=""><figcaption><p>Imagem 3 - Campo Evento com a lista de eventos cadastrados.</p></figcaption></figure>

***

#### 📋 Campos

Após selecionar o evento, os campos personalizados definidos no cadastro dele aparecem automaticamente para você preencher — podendo ser texto, número, data, seleção entre opções ou verdadeiro/falso. Você pode usar variáveis do fluxo nesses campos.

{% hint style="warning" %}
Preencha sempre os campos do evento corretamente. Alguns tipos de campo (como número, data e seleção) são validados apenas no momento da execução do fluxo — um valor inválido pode fazer o módulo seguir pela saída de Erro.
{% endhint %}

***

#### 🔀 Saídas do módulo

O módulo tem duas saídas:

* **Sucesso** — o evento foi registrado com sucesso.
* **Erro** — não foi possível registrar o evento (por exemplo, evento não encontrado, Analytics não habilitado, ou limite de créditos atingido).

<figure><img src="https://3829578295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRWteFkm020DS5IbXoSgj%2Fuploads%2FJHYza30tyQF4gT0Cooxq%2F01-visao-geral-canvas.png?alt=media&amp;token=ec7afd78-563a-4a63-86d8-1b64afd3bf76" alt=""><figcaption><p>Imagem 4 - Módulo na área de trabalho do fluxo mostrando as saídas Sucesso e Erro.</p></figcaption></figure>

***

### 💡 Caso de uso

**Cenário:** uma empresa quer acompanhar, em tempo real, quantos clientes concluem uma determinada etapa importante do atendimento.

**Configuração:**

1. Cadastre um evento na tela **Eventos**, com um campo de texto para identificar a etapa concluída.
2. Adicione o módulo **Evento** ao fluxo, no ponto em que a etapa é concluída.
3. Selecione o evento cadastrado e preencha o campo com a informação da etapa.
4. Conecte a saída **Sucesso** para dar continuidade ao atendimento.

**Resultado:** a empresa passa a acompanhar, em tempo real, quantos clientes completam essa etapa do atendimento.

***

### 📌 Dicas úteis

* Cadastre o evento e seus campos com atenção — depois de criado, os campos existentes não podem ser removidos ou alterados, apenas novos campos podem ser adicionados.
* Sempre conecte a saída **Erro** a algum tratamento, já que o registro do evento pode falhar por diversos motivos.
* Acompanhe o consumo de eventos gratuitos e a cobrança adicional, especialmente em fluxos de alto volume.

***

### 📝 Resumo

* O módulo **Evento** registra um evento personalizado, previamente cadastrado, para monitoramento e automação.
* Os campos disponíveis dependem do cadastro do evento escolhido.
* O módulo tem uma saída de **Sucesso** e uma de **Erro**.