Saltar para o conteúdo principal
Os webhooks fornecem notificações em tempo real sobre eventos como a creação, actualização ou eliminação de campanhas. Para receber essas notificações, você deve especificar uma URL de acesso público capaz de receber solicitações POST HTTP.

​
Como Funciona

Quando um evento ocorre, uma solicitação POST HTTP contendo os detalhes do evento é enviada à sua URL especificada. Sua URL deve retornar um código de status HTTP 2xx para solicitações bem-sucedidas.
Os webhooks são criados através da API Criar webhook (API), onde você define o evento acionador utilizando o campo de canal. Apenas um webhook é permitido por canal.

​
Tentativas e validação

Se a URL do seu webhook não estiver acessível, tentaremos enviar a solicitação até 5 vezes em 1 minuto, utilizando retrocesso exponencial. As tentativas ocorrem apenas para códigos de status HTTP 5xx ou 429.
Para garantir a autenticidade e integridade das entregas de webhook, você deve validar a assinatura. A Topsort gera uma assinatura utilizando o seu segredo de webhook e o payload do evento, incluindo-a no cabeçalho HTTP X-TS-Signature-256.
Você pode definir o seu segredo de webhook durante a criação; caso contrário, um será gerado automaticamente. Armazene o seu segredo de forma segura.
A Topsort utiliza o resumo hexadecimal HMAC (que começa com sha256=) para calcular a assinatura. Você deve recalcular o hash no seu servidor e compará-lo com o cabeçalho X-TS-Signature-256 para verificar a assinatura.

​
Exemplo de verificação de assinatura

import hmac
import hashlib

secret = "my-webhook-secret"
request = ... # incoming request from the webhook delivery

signature = hmac.new(
    key=secret.encode(),
    msg=await request.body(),
    digestmod=hashlib.sha256,
).hexdigest()

expected_signature = "sha256=" + signature
incoming_signature = request.headers["X-TS-Signature-256"]

if not hmac.compare_digest(incoming_signature, expected_signature):
    # The signature is not valid, do not process the delivery
else:
    # The signature is valid, process the delivery
Última atualização: