Integração de Webhook

Visão geral da integração

Esta integração permite que você configure um endpoint de Webhook para receber dados em tempo real da Pushwoosh, especificamente eventos de status de E-mail, como E-mail Enviado, E-mail Entregue, E-mail Devolvido, E-mail Aberto, etc.

Tipo de integração

Fonte: Os dados são enviados da Pushwoosh para o seu sistema através do webhook.

Glossário

Endpoint de Webhook: Uma URL do lado do servidor que recebe solicitações HTTP POST da Pushwoosh. Os clientes podem especificar a porta exata.

Exemplo sem porta: https://clientdomainname.com/webhook_endpoint
Exemplo com a porta especificada: https://clientdomainname.com:8081/webhook_endpoint

Entidades sincronizadas

Eventos de status de e-mail que fornecem dados sobre as interações do usuário com as mensagens que você envia.

Configurando a integração

Para configurar a integração:

Na sua conta Pushwoosh, vá para Configurações > Integrações de Terceiros e encontre Integração de Webhook. Clique em Configurar.

Na janela que se abre, insira a URL completa do endpoint do webhook e clique em Aplicar.

Uma vez configurado com sucesso, você começará a receber solicitações da Pushwoosh.

Como verificar se a integração está funcionando

Uma vez que a integração esteja configurada, você receberá solicitações HTTP POST da Pushwoosh no endpoint de webhook especificado.

Corpo da solicitação do Webhook

Nome do campo	Tipo	Obrigatório	Descrição	Exemplo
event_name	string	Sim	O nome do evento	`"Email Sent"`
message_id	uint64	Não	O ID único da mensagem associada ao evento.	`200XXXX3258`
message_code	string	Sim	O código da mensagem associada ao evento.	`"B780-XXXXXX3C-XXXX0375"`
campaign_id	uint64	Não	O ID único da campanha associada ao evento.	`96XXXX`
platform	string	Sim	A plataforma do dispositivo associada ao evento (por exemplo, iOS, Android, E-mail).	`"Email"`
application_code	string	Sim	O código do aplicativo associado ao evento.	`"3XXXX-XXXX1"`
hwid	string	Sim	O identificador do dispositivo (HWID) associado ao evento.	`"example@gmail.com"`
user_id	string	Sim	O User ID da Pushwoosh associado ao evento.	`"15XXXX8"`
payload	string	Não	O conteúdo relacionado à mensagem depende da plataforma. Para eventos de E-mail, este campo contém o assunto do e-mail. Para outras plataformas, pode incluir diferentes conteúdos relevantes específicos do evento (por exemplo, conteúdo ou título da mensagem).	`"Don't miss our summer sale!"`
timestamp	int64	Sim	A hora em que o evento ocorreu, no formato de timestamp UNIX.	`1723798222`
journey_title	string	Não	O título da Journey associada ao evento.	`"Summer sale"`
journey_point_title	string	Não	O título do ponto específico dentro da Journey associado ao evento.	`"5_summer sale_new"`

Exemplo de solicitação

{
  "event_name": "Email Sent",
  "message_code": "B780-XXXXXX3C-XXXX0375",
  "campaign_id": 96XXXX,
  "platform": "Email",
  "payload": "Don't miss our summer sale!",
  "application_code": "3XXXX-XXXX1",
  "hwid": "example@gmail.com",
  "user_id": "15XXXX8",
  "timestamp": 1723798222,
  "journey_title": "Summer sale",
  "journey_point_title": "5_summer sale_promoemail"
}