---
title: "Webhooks (variação OPAP)"
slug: "webhooks-opap-variation"
updated: 2026-06-12T10:30:59Z
published: 2026-06-12T10:30:59Z
canonical: "docs.xtremepush.com/webhooks-opap-variation"
---

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

# Webhooks (variação OPAP)

Integração personalizada com webhooks para se adequar ao formato OPAP sob medida

A página a seguir descreve a configuração específica dos webhooks para a configuração OPAP. Além dos detalhes abaixo, toda a funcionalidade dos outros webhooks é a mesma da integração com [**webhooks**](/documentation/docs/pt-br/webhooks-integration) regulares.

> [!TIP]
> Suporte para múltiplos canais:
> 
> Receba dados para push, e-mail, SMS e mensagens dentro do app.

## Configurações de Segurança do Webhook[](/docs/pt-br/webhooks-opap-variation#webhook-security-settings)

Para essa integração com webhook, **o Bearer Token** é o tipo de autenticação exigido e deve ser copiado da plataforma receptora do cliente.

Um token JWT é necessário para descriptografar o conteúdo da mensagem na plataforma receptora do cliente. Ele é gerado automaticamente pelo Xtremepush ao configurar um novo webhook, mas pode ser atualizado a qualquer momento, se necessário, clicando no **botão Gerar Chave JWT** .

> [!NOTE]
> Restrições de IP
> 
> Se a plataforma receptora exigir um endereço IP previamente permitido para receber a mensagem, isso precisará ser configurado pelo Xtremepush com antecedência. Converse com seu Gerente de Conta para organizar isso.

## Formato Webhooks[](/docs/pt-br/webhooks-opap-variation#webhooks-format)

O conteúdo da mensagem usa um formato especial contendo apenas dois campos. A mensagem é codificada.

Exemplo:

```json
{
  "externalMessageId": "123",
  "status": "delivered / clicked / failed"
}
```

Para campanhas dentro do aplicativo, você pode adicionar IDs de campanha e usuários ao conteúdo da mensagem usando `pushCampaignId `e `customerId` conforme mostrado no exemplo abaixo:

```json
{
  "externalMessageId": "123",
  "status": "delivered / clicked / failed",
  "pushCampaignId": "12",
  "customerId":"15"
}
```

> [!TIP]
> Tipo de solicitação
> 
> A integração do webhook OPAP utiliza requisições PATCH.

## Engajamento com Mensagens Webhook[](/docs/pt-br/webhooks-opap-variation#webhook-message-engagement)

### Visão geral[](/docs/pt-br/webhooks-opap-variation#overview)

Você pode configurar seu webhook para receber atualizações em tempo real sobre o engajamento das mensagens da campanha. Quando ocorre uma ação como entrega, falha ou clique, o Xtremepush envia uma requisição POST para seu endpoint com o status da mensagem da campanha.

Você pode acompanhar o desempenho das mensagens visualizando o status da mensagem na seção **Campanhas** da aba **Monitor** .

### Configuração[](/docs/pt-br/webhooks-opap-variation#configuration)

Para habilitar eventos de engajamento de mensagens para seu webhook:

1. **Em Configurações** > **Integrações** > **Marketplace**>**Integrações Configuradas**, selecione a integração de webhook configurada que deseja usar.
2. Role até a seção de **Configurações de Eventos de Engajamento de Mensagens do Webhook** .
3. Ative os eventos de mensagem específicos que deseja receber para cada canal.

### Códigos de Status[](/docs/pt-br/webhooks-opap-variation#status-codes)

O status no payload do webhook indica o status da sua mensagem de campanha.

**Exemplo de carga útil**:

```json
{
  "externalMessageId": "123",
  "status": "sent"
}
```

A tabela abaixo descreve os possíveis códigos de status:

| Status | Descrição |
| --- | --- |
| enviado | A mensagem foi enviada com sucesso a partir da plataforma Xtremepush. |
| Falhou | A mensagem não pôde ser enviada ou foi rejeitada pelo servidor do destinatário. |
| entregue | A mensagem foi entregue com sucesso e vista pelo seu usuário. |
| clique | Seu usuário clicou em um link ou botão rastreado dentro da mensagem. |
| fechado | Seu usuário fechou ou descartou a mensagem da campanha no aplicativo. Este status é aplicável apenas a mensagens no aplicativo |