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 regulares.

Suporte para múltiplos canais: 

Receba dados para push, e-mail, SMS e mensagens dentro do app.

Configurações de Segurança do Webhook

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 .

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

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

Exemplo:

{
  "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:

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

Tipo de solicitação

A integração do webhook OPAP utiliza requisições PATCH.

Engajamento com Mensagens Webhook

Visão geral

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

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

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

Exemplo de carga útil:

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

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