Passar para o conteúdo principal

Documentação dos Webhooks da AdOpt

Escrito por AdOpt Support
Atualizado há mais de 5 meses

Os webhooks da AdOpt permitem que você receba notificações em tempo real sobre eventos importantes relacionados à sua conta. Ao configurar webhooks, você pode receber informações atualizadas diretamente em seu sistema ou aplicativo externo, facilitando a integração e a automação de processos.

1. Criando um Webhook

Para criar um webhook, siga os seguintes passos:

  1. Acesse a aba "Webhooks" dentro do seu dashboard da AdOpt.

  2. Procure pela opção de criar um novo webhook.

  3. Preencha as informações necessárias, como o nome do webhook e o endpoint de destino.

  4. Após salvar as configurações, seu webhook estará pronto para receber notificações.

2. Configurando a Assinatura

Ao criar um webhook, você terá uma secret signing exclusiva. Essa secret signing será usada para validar o envio do webhook. O endereço do webhook consiste em um corpo JSON contendo a signature (assinatura HMAC) e os dados relevantes do evento.

3. Recebendo Eventos

Quando um evento ocorrer, a AdOpt enviará uma solicitação POST para o endpoint configurado do seu webhook. A solicitação conterá um corpo JSON contendo informações sobre o evento específico.

4. Validando a Chamada

Para garantir a autenticidade da chamada do webhook, é necessário validar se a assinatura corresponde ao HMAC da solicitação. O HMAC é calculado usando a secret signing disponível no seu dashboard da AdOpt.

Para validar a chamada do webhook, siga estes passos:

  1. Extraia a secret signing do nosso dashboard e salve no seu sistema.

  2. Calcule o HMAC usando a secret signing e os dados recebidos no corpo da solicitação.

  3. Compare a assinatura HMAC calculada com a assinatura incluída na solicitação.

  4. Se as assinaturas coincidirem, a chamada do webhook é considerada válida.

💡 Dica: É altamente recomendável que você implemente mecanismos de segurança para proteger a integridade e a confidencialidade dos dados transmitidos.

Conclusão

Os webhooks da AdOpt são uma ferramenta poderosa para receber notificações em tempo real sobre eventos importantes relacionados à sua conta. Ao seguir as instruções fornecidas nesta documentação, você poderá configurar e validar seus webhooks com segurança, integrando-os perfeitamente ao seu sistema ou aplicativo externo.

Respondeu à sua pergunta?