Início  /  Integrações   /  Como usar os Webhooks da Snov.io

Como usar os Webhooks da Snov.io

Resumo:

Os webhooks são uma maneira de os aplicativos se comunicarem entre si. Em essência, são notificações enviadas de um aplicativo para outro quando ocorre um evento predeterminado:

  • Um aplicativo aciona um webhook quando ocorre um evento escolhido
  • O outro aplicativo recebe informações em tempo real sobre o evento

Por exemplo, quando um destinatário responde a um e-mail de campanha, um webhook é enviado para o endpoint de URL especificado. O endpoint pode então agir com base nas informações recebidas de um webhook. Isso cria possibilidades para configurar integrações automatizadas. Usando Webhooks da Snov.io, você pode:

 Integrar seu próprio aplicativo com a Snov.io

Ser notificado de eventos ou atividades que aconteceram em sua conta Snov.io

Enviar dados em tempo real da Snov.io para seu aplicativo

Existem três webhooks disponíveis na Snov.io no momento (no futuro, teremos mais atualizações):

E-mail enviado (Email sent)
A Snov.io enviará um webhook quando sua campanha de gotejamento de e-mail for enviada. Você pode escolher quando obtê-lo: somente quando o primeiro e-mail for enviado a um destinatário ou após cada e-mail enviado.

Resposta da campanha recebida (Campaign reply received)

A Snov.io enviará um webhook quando você receber uma resposta à sua campanha de gotejamento por e-mail. Você pode escolher quando recebê-lo: somente após a primeira resposta de um destinatário ou após cada resposta.

As informações do webhook incluirão:

  • E-mail do destinatário
  • Timestamp de um evento: quando o evento ocorreu
  • Nome da campanha: o nome da campanha de gotejamento em que o evento ocorreu
  • Assunto do e-mail: a linha de assunto do e-mail enviado a um destinatário
  • Corpo do e-mail: o conteúdo do e-mail enviado a um destinatário

E-mail da campanha aberto (Campaign email opened)

A Snov.io enviará um webhook quando seu e-mail de campanha de gotejamento for visualizado por um destinatário.

As informações do webhook incluirão:

  • E-mail do destinatário 
  • Timestamp de um evento: quando o evento ocorreu
  • Nome da campanha: o nome da campanha de gotejamento onde ocorreu o evento
  • Assunto do e-mail: a linha de assunto do e-mail enviado a um destinatário
  • Corpo do e-mail: o conteúdo do e-mail enviado a um destinatário 

Parâmetros de webhooks da Snov.io

Os parâmetros do webhook incluem o seguinte:

  • Objeto: o objeto sobre o qual a ação é executada. Em outras palavras, este é um componente da Snov.io (e-mail, resposta, prospecto ou negócio) vinculado a um webhook.
  • Ação: a ação realizada no objeto. Simplificando, este é o evento que ativa um webhook.
  • Endpoint: o endereço da URL para onde o webhook é enviado.

Abaixo está a lista de objetos e ações atualmente disponíveis:

Objeto

Ação

Quando é ativado?

campaign_email

sent

Quando qualquer e-mail é enviado ao destinatário em qualquer campanha de gotejamento
first_sent Quando o primeiro e-mail é enviado ao destinatário em qualquer campanha de gotejamento
opened Quando o destinatário abre um e-mail em qualquer uma das campanhas de gotejamento

campaign_reply

 

 received Quando o destinatário responde a qualquer e-mail em qualquer uma das campanhas de gotejamento
first_received Quando o destinatário responde ao e-mail pela primeira vez em qualquer uma das campanhas de gotejamento

Como assinar webhooks via API da Snov.io

Para ver um webhook sendo executado em tempo real, vamos usar o Postman e qualquer um dos geradores de endpoint online.

Prepare o ambiente de teste da API e obtenha um token de acesso à API

Inscreva-se com o Postman

Obtenha um token de acesso à API

Prepare uma chamada de API e autentique-a com um token de acesso

Aqui está um passo a passo detalhado sobre como autenticar sua chamada de API da Snov.io e usar o Postman para chamadas de API.

  Obtenha um endereço de endpoint de URL

Como exemplo, usaremos o Beeceptor para gerar um endpoint gratuito. Em seu site, digite qualquer nome de endpoint e clique no botão Create endpoint.

Você obterá um endereço de URL de terminal para o qual um webhook e dados relacionados a um evento na Snov.io serão enviados. Salve ou copie este URL para usá-lo na próxima etapa.

  Assine um webhook por meio de chamada de API 

Use as configurações abaixo para fazer uma chamada de API no Postman ou em qualquer outro ambiente de teste de API de sua escolha:

  • Tipo: POST
  • URL de solicitação: https://api.snov.io/v2/webhooks
  • Parâmetros de entrada (consulte também o capítulo de parâmetros do Webhook acima):

Parâmetros de Entrada

event_object

campaign_email

campaign_reply

event_action

 sent ou first_sent received ou first_received
endpoint_url https://snovio.free.beeceptor.com

Após inserir todos os parâmetros, clique no botão Send. Você verá a seguinte resposta:

“status”: “active” significa que você se inscreveu com sucesso em um webhook.

  Verifique a notificação do webhook na URL do endpoint

Consideramos que um webhook foi recebido com sucesso pelo endpoint se ele retornar um código de resposta de status de sucesso 200 OK em 3 segundos.

Se isso não acontecer, faremos várias tentativas para reenviar um webhook:

1º : imediatamente após o evento

2º : 20 minutos após a última tentativa (20 minutos após o evento)

3º : 40 minutos após a última tentativa (1 hora após o evento)

4º : 60 minutos após a última tentativa (2 horas após o evento)

5º : 4 horas após a última tentativa (6 horas após o evento)

6º : 8 horas após a última tentativa (14 horas após o evento)

7º : 24 horas após a última tentativa (38 horas após o evento)

Se todas as sete tentativas não forem bem-sucedidas, o webhook será desativado.

Volte para o Beeceptor e encontre um registro POST com dados de webhook da Snov.io. Aqui está um exemplo de como fica:

Depois de se inscrever em um webhook, sempre que um evento escolhido ocorrer em sua conta da Snov.io, os dados relacionados a um evento serão instantaneamente transmitidos ao endpoint de URL.

Como gerenciar webhooks via API da Snov.io

Veja a lista com seus webhooks

Excluir uma assinatura de webhookInclua o valor “id” exclusivo do webhook escolhido no final do endereço URL da solicitação.

Use o método “Listar todos os webhooks” para obter os valores de ID dos seus webhooks.

  • Digite: APAGAR
  • URL de solicitação : https://api.snov.io/ v2/webhooks/webhook_id
  • Parâmetros de entrada : Este método não possui parâmetros de entrada.
  • Exemplo de URL de solicitação: https://api.snov.io/v2/webhooks/8

 

Alterar status do webhook

Altera o status de uma assinatura de webhook escolhida.

Inclua o valor “id” exclusivo do webhook escolhido no final do endereço URL da solicitação.

Use o método “Listar todos os webhooks” para obter os valores de ID dos seus webhooks.

 Status   ativo ou desativado
  • Exemplo de URL de solicitação: https://api.snov.io/v2/webhooks/14

Observação: você pode criar até 50 webhooks. Eles estão disponíveis apenas para contas premium.

Atualize seu plano agora, expanda a funcionalidade de sua conta Snov.io e assine webhooks!

 

Escrito por 27 06 2022
Isso te ajudou?

Obrigado por seu feedback!

Sinto por isso 😢

Como podemos melhorar?