> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# URLs de notificação

> Envie eventos das suas campanhas para sistemas externos em tempo real.

As URLs de notificação permitem enviar eventos do WhatsApp para sistemas externos em tempo real.

Em `Configurações` você pode criar uma URL associada a um bot específico.\
Isso proporciona controle independente baseado no fluxo ou caso de uso.

## Para que servem?

Permitem que seu sistema receba automaticamente informações quando um evento ocorre em uma campanha ou mensagem.

Por exemplo:

* Confirmar que uma mensagem foi lida
* Detectar uma falha de envio
* Registrar quando um usuário responde

Tudo sem intervenção manual.

## Como configurar uma URL de notificação

Ao criar uma nova URL, você precisará:

1. Selecionar o tipo de evento que deseja receber:
   * Leitura
   * Falha
   * Resposta
   * Todos (inclui todos os eventos)
2. Informar a URL de destino (endpoint).
3. Definir o tipo de autenticação que o endpoint usará.

Cada configuração é feita por bot, o que permite personalizar a integração de acordo com a lógica de cada fluxo.

<Warning>
  Para receber eventos do tipo **Leitura**, o usuário do WhatsApp deve ter a função de **confirmações de leitura** (tiques azuis) habilitada no seu dispositivo. Se o usuário tiver essa opção desativada, a plataforma não receberá a notificação de leitura e, portanto, o evento não será enviado para sua URL de notificação.
</Warning>

## Benefícios

**Maior flexibilidade**\
Você pode definir uma URL para um evento específico ou agrupar todos em uma só.

**Mais segurança**\
Configure o método de autenticação que melhor se adapta ao seu ambiente técnico.

**Administração mais simples**\
Menos configurações duplicadas e melhor organização.

**Melhor experiência operacional**\
Interface clara para gerenciar notificações de forma organizada e eficiente.

<Note>
  As URLs de notificação são essenciais quando você precisa integrar a Jelou com um CRM, sistemas internos ou ferramentas de analytics em tempo real.
</Note>

## Exemplos de eventos

A seguir estão exemplos do payload que você receberá na sua URL de notificação de acordo com o tipo de evento:

<AccordionGroup>
  <Accordion title="Falha">
    Enviado quando a mensagem não pôde ser entregue.

    ```json theme={null}
    {
      "id": "c75170d3-917d-48a4-8b15-*********",
      "status": "FAILED",
      "error": "buttons: Button at index 0 of type Url requires a parameter",
      "timestamp": "1777325700",
      "campaignId": "69efd6834d469ea6*********",
      "destination": "5939800000000",
      "isFinalEvent": true,
      "template": "autentica_01"
    }
    ```
  </Accordion>

  <Accordion title="Entregue ao canal">
    Enviado quando a mensagem foi entregue ao canal (WhatsApp).

    ```json theme={null}
    {
      "id": "f777ebe8-41f5-4ffd-9c86-*********",
      "status": "DELIVERED_CHANNEL",
      "timestamp": "1777326454",
      "campaignId": "69efd9747eba1414ecbc66d2",
      "destination": "5939800000000",
      "isFinalEvent": true,
      "template": "template_name"
    }
    ```
  </Accordion>

  <Accordion title="Entregue ao usuário">
    Enviado quando a mensagem foi entregue ao dispositivo do usuário.

    ```json theme={null}
    {
      "id": "78518db4-4f5d-451f-a4ad-*********",
      "status": "DELIVERED_USER",
      "timestamp": "1777326039",
      "campaignId": "69efd7d4b5095a8*********",
      "destination": "5939800000000",
      "isFinalEvent": true,
      "template": "plantilla_lto_kevin_ai"
    }
    ```
  </Accordion>

  <Accordion title="Lido">
    Enviado quando o usuário leu a mensagem.

    ```json theme={null}
    {
      "id": "c3eca84b-3fcf-4038-80e7-*********",
      "status": "READ",
      "timestamp": "1777326047",
      "campaignId": "69efd5bfc2da2*********",
      "destination": "5939800000000",
      "isFinalEvent": true,
      "template": "template_name"
    }
    ```

    <Warning>
      Este evento só é recebido se o usuário tiver as **confirmações de leitura** (tiques azuis) habilitadas no WhatsApp.
    </Warning>
  </Accordion>

  <Accordion title="Resposta">
    Enviado quando o usuário responde à mensagem.

    ```json theme={null}
    {
      "id": "f777ebe8-41f5-4ffd-9c86-*********",
      "campaignId": "69efd9747eba141*********",
      "reply": "button_name",
      "template": "template_name",
      "timestamp": "1777326462",
      "status": "REPLY",
      "isFinalEvent": true,
      "destination": "5939800000000"
    }
    ```
  </Accordion>
</AccordionGroup>