Documentação
Webhooks

O que é um webhook

Um webhook é uma ferramenta que permite a um sistema ou aplicativo enviar notificações sobre um evento específico a outro sistema ou aplicativo em tempo real.

Dessa forma, ao configurar os webhooks do EnvíaloSimple você poderá conectá-los a uma URL pública (pertencente ao sistema ou aplicativo de destino) para a qual as notificações serão enviadas quando um evento específico ocorrer na ferramenta. Por exemplo: o envio de uma campanha, a assinatura de um contato, entre outros, otimizando seu fluxo de trabalho de email marketing.

Configuração no EnvíaloSimple

Configurar um webhook é muito simples e você pode fazê-lo seguindo estes passos:

1. 1) Assim que você fizer login no EnvíaloSimple, vá para Configurações.
2. 2) Em seguida, entre na seção de Webhooks pelo menu lateral.
3. 3) Lá, você terá que copiar a URL pertencente ao sistema ou aplicativo ao qual será integrado. (Você deve adicionar o formato http(s) no início)
4. 4) Em seguida, você verá a lista completa de eventos disponíveis, onde poderá selecionar aqueles dos quais deseja receber notificações.
5. 5) Ao final, lembre-se de salvar as alterações.

Detalhe dos eventos

Abertura de campanha

Esta notificação é enviada quando um contato abre uma campanha. Se o mesmo contato abrir a mesma campanha várias vezes, só será notificado na primeira vez, evitando redundância e focando em métricas de abertura únicas.

Dados que retorna:

Nome	Descrição
id	ID único do evento.
event	Tipo de evento: “campaign_read”.
email	E-mail do contato que abriu a campanha.
ts_event	Data/hora em que a abertura foi realizada.
campaign_id	ID da campanha que foi aberta.
campaign_name	Nome da campanha que foi aberta.
ts_sent	Data/hora de envio da campanha que foi aberta.

Exemplo:

{
   id: "39f3abfc43b23e",
   event: "campaign_read",
   email: "[email protected]",
   ts_event: 1631199366,
   campaign_id: "383",
   campaign_name: "Campaña de Prueba",
   ts_sent: 1631198557,
}
                    

Campanha enviada

Uma notificação é enviada após o envio bem-sucedido de uma campanha, permitindo o monitoramento em tempo real do status de entrega.

Dados que retorna:

Nome	Descrição
id	ID único do evento.
event	Tipo de evento: “campaign_sent”.
ts_event	Data/hora em que a campanha foi enviada.
campaign_id	ID da campanha que foi enviada.
campaign_name	Nome da campanha que foi enviada.

Exemplo:

{
   id: "61269d5887e2f",
   event: "campaign_sent",
   ts_event: 1629920600,
   campaign_id: "200",
   campaign_name: "Nombre de la Campaña",
}
                    

Clique em uma campanha

Uma notificação é enviada quando um contato clica em algum link da campanha, fornecendo insights sobre o engajamento e a performance dos seus CTAs.

Dados que retorna:

Nome	Descrição
id	ID único do evento.
event	Tipo de evento: “campaign_click”.
email	E-mail do contato que clicou na campanha.
ts_event	Data/hora em que o clique foi realizado.
campaign_id	ID da campanha em que se clicou.
campaign_name	Nome da campanha em que se clicou.
ts_sent	Data/hora de envio da campanha em que se clicou.
campaign_url	Link da campanha em que se clicou.

Exemplo:

{
   id: "39f3abff06dbcc",
   event: "campaign_click",
   email: "[email protected]",
   ts_event: 1631199371,
   campaign_id: "383",
   campaign_name: "Campaña de Prueba",
   ts_sent: 1631198557,
   campaign_url: "http://www.google.com?mkt_hm=1&utm_source=email_marketing&utm_admin=123&utm_medium=email&utm_campaign=Prueba_Webhooks",
}
                    

Assinatura de contato

Uma notificação é enviada quando:

• O contato se inscreve em uma ou várias listas a partir dos formulários (a notificação é enviada quando a confirmação do e-mail é recebida).
• O administrador inscreve o contato entrando na lista e adicionando-o.
• O administrador cria um contato individual atribuindo-o a uma ou várias listas.

Dados que retorna:

Nome	Descrição
id	ID único do evento.
event	Tipo de evento: “member_subscribe”.
ts_event	Data/hora da assinatura.
email	E-mail do contato que se inscreveu.
list_ids	IDs das listas às quais se inscreveu.

Exemplo:

{
   id: "612cfec2819fb",
   event: "member_subscribe",
   ts_event: 1630338754,
   email: "[email protected]",
   list_ids: [
      "13",
   ],
}
                    

Desassinatura de contato

Uma notificação é enviada quando:

• O contato se desinscreve de uma ou de todas as listas a partir do link fornecido no rodapé das campanhas.
• O administrador desinscreve o contato entrando na lista e removendo-o.

Dados que retorna:

Nome	Descrição
id	ID único do evento.
event	Tipo de evento: “member_unsubscribe”.
ts_event	Data/hora da desassinatura.
reason	Razão da desassinatura. Valores possíveis: delete ⇒ Para a desassinatura realizada a partir da lista alreadyUnsubscribed ⇒ Já me desinscrevi irrelevant ⇒ Conteúdos irrelevantes neverSignUp ⇒ Nunca me inscrevi other ⇒ Outros spam ⇒ Considero SPAM tooOften ⇒ Muita frequência
email	E-mail do contato que se desinscreveu.
list_ids	IDs das listas das quais se desinscreveu.
campaign_id	ID da campanha da qual se desinscreveu. Apenas para desassinatura a partir do link da campanha.
campaign_name	Nome da campanha da qual se desinscreveu. Apenas para desassinatura a partir do link da campanha.
ts_sent	Data/hora de envio da campanha da qual se desinscreveu. Apenas para desassinatura a partir do link da campanha.

Exemplo:

{
   id: "612d0604472c8",
   event: "member_unsubscribe",
   ts_event: 1630340612,
   reason: "irrelevant",
   email: "[email protected]",
   list_ids: [
      "5",
   ],
   campaign_id: "201",
   campaign_name: "Campaña de Prueba",
   ts_sent: 1630340179,
}