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

# Eventos dos Webhooks

> Receba no seu servidor quando o push for enviado, entregue, clicado, falhar ou for cancelado.

<Tip>
  Na API você **pergunta**; no webhook a Notifique **avisa**. Ideal para marcar entrega, medir cliques ou remover device com subscription inválida, sem polling.
</Tip>

## Em poucas palavras

* Toda entrega é um **POST** `application/json` para a URL cadastrada.
* Eventos `push.*` são **só push**, WhatsApp usa `message.*`, SMS usa `sms.*`.
* `instanceId` vem **vazio** (push não usa instância de canal).
* Ative **só** os eventos que sua integração usa.
* Responda **2xx rápido**; processamento pesado vai para fila no seu lado.

Configuração geral: [Webhooks](/guides/webhooks/index). Segurança (assinatura HMAC): [Segurança de webhooks](/guides/webhooks/seguranca).

***

## Como vem o POST

```json theme={null}
{
  "event": "push.delivered",
  "workspaceId": "clxx123...",
  "instanceId": "",
  "timestamp": "2025-02-10T14:30:00.000Z",
  "data": {
    "pushId": "clxx456...",
    "deviceId": "clxx789...",
    "appId": "clxxabc...",
    "status": "DELIVERED",
    "deliveredAt": "2025-02-10T14:30:05.000Z"
  }
}
```

| Campo         | Descrição                                                       |
| ------------- | --------------------------------------------------------------- |
| `event`       | Nome do evento (ex.: `push.delivered`)                          |
| `workspaceId` | ID do workspace                                                 |
| `instanceId`  | Sempre vazio no push                                            |
| `timestamp`   | ISO 8601, use para anti-replay                                  |
| `data`        | Campos do envio (`pushId`, `deviceId`, `appId`, `status`, etc.) |

Headers: `X-Notifique-Signature`, `X-Notifique-Timestamp`, `X-Workspace-Id`, `X-Webhook-Event`.

***

## O que seu servidor deve responder

| Resposta                | Efeito                                      |
| ----------------------- | ------------------------------------------- |
| **2xx** em até \~10s    | Evento entregue; sai da fila                |
| **4xx / 5xx / timeout** | Retentativa automática (5 min, 30 min, 2 h) |

<Note>
  Processamento demorado? Responda **200** logo e processe em background.
</Note>

***

## Referência por evento

| Evento           | Quando dispara                       | O que fazer com isso        |
| ---------------- | ------------------------------------ | --------------------------- |
| `push.sent`      | Push aceito e enviado ao provedor    | Marcar como enviado         |
| `push.delivered` | Dispositivo confirmou entrega        | Métricas de entrega         |
| `push.clicked`   | Usuário abriu a notificação          | Deep link, conversão        |
| `push.failed`    | Subscription inválida ou erro        | Remover ou atualizar device |
| `push.cancelled` | Agendamento cancelado antes do envio | Atualizar fila              |

***

## Payload de cada evento

<AccordionGroup>
  <Accordion title="push.sent">
    ```json theme={null}
    {
      "event": "push.sent",
      "workspaceId": "clxx123...",
      "instanceId": "",
      "timestamp": "2025-02-10T14:29:00.000Z",
      "data": {
        "pushId": "clxx456...",
        "deviceId": "clxx789...",
        "appId": "clxxabc...",
        "status": "SENT",
        "title": "Olá!",
        "sentAt": "2025-02-10T14:29:00.000Z"
      }
    }
    ```
  </Accordion>

  <Accordion title="push.delivered">
    Disparado quando o **service worker** ou cliente reporta entrega.

    ```json theme={null}
    {
      "event": "push.delivered",
      "workspaceId": "clxx123...",
      "instanceId": "",
      "timestamp": "2025-02-10T14:30:00.000Z",
      "data": {
        "pushId": "clxx456...",
        "deviceId": "clxx789...",
        "appId": "clxxabc...",
        "status": "DELIVERED",
        "deliveredAt": "2025-02-10T14:30:05.000Z"
      }
    }
    ```
  </Accordion>

  <Accordion title="push.clicked">
    ```json theme={null}
    {
      "event": "push.clicked",
      "workspaceId": "clxx123...",
      "instanceId": "",
      "timestamp": "2025-02-10T14:35:00.000Z",
      "data": {
        "pushId": "clxx456...",
        "deviceId": "clxx789...",
        "appId": "clxxabc...",
        "status": "CLICKED",
        "clickedAt": "2025-02-10T14:35:00.000Z",
        "url": "https://seusite.com/notificacoes"
      }
    }
    ```
  </Accordion>

  <Accordion title="push.failed">
    Boa prática: desativar ou remover o **deviceId** ao receber subscription inválida.

    ```json theme={null}
    {
      "event": "push.failed",
      "workspaceId": "clxx123...",
      "instanceId": "",
      "timestamp": "2025-02-10T14:29:30.000Z",
      "data": {
        "pushId": "clxx456...",
        "deviceId": "clxx789...",
        "appId": "clxxabc...",
        "status": "FAILED",
        "failedAt": "2025-02-10T14:29:30.000Z",
        "errorMessage": "subscription_expired"
      }
    }
    ```
  </Accordion>

  <Accordion title="push.cancelled">
    ```json theme={null}
    {
      "event": "push.cancelled",
      "workspaceId": "clxx123...",
      "instanceId": "",
      "timestamp": "2025-02-10T12:00:00.000Z",
      "data": {
        "pushId": "clxx456...",
        "deviceId": "clxx789...",
        "appId": "clxxabc...",
        "status": "CANCELLED"
      }
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Próximos passos

* [Quick Start](/push-api/como-funciona/quick-start): app → dispositivo → envio
* [Introdução](/push-api/como-funciona/introducao): ciclo de status
* [Escopos](/push-api/como-funciona/escopos-da-api-key): permissões da chave
* [Webhooks (guia geral)](/guides/webhooks/index)