Skip to main content

Visao geral

A Rewrite envia webhooks como requests HTTPS POST com body JSON. As familias publicas de evento hoje sao:

Registro do webhook

Voce pode criar webhooks no dashboard ou via POST /webhooks. Exemplo:

Formato da entrega

A Rewrite envia hoje:
  • Content-Type: application/json
  • User-Agent: rewrite-webhooks/1.0
  • svix-id
  • svix-timestamp
  • svix-signature
Exemplo de payload:
  • data.contact e data.contactId sempre existem. Eles ficam null quando o envio original nao usou um contato salvo.
  • sandbox no envelope indica o modo do projeto que originou o evento.
  • data.sandbox repete essa informacao nos payloads de mensagem.
  • Nas respostas de leitura do recurso de webhook, retries e timeout aparecem no topo. Nos requests de create/update, eles entram dentro de delivery.

Validacao de assinatura

Valide a assinatura antes de confiar no body. Detalhes importantes:
  • Use o raw body da request.
  • Leia svix-id, svix-timestamp e svix-signature nos headers.
  • Verifique contra o segredo retornado por POST /webhooks ou GET /webhooks/{id}.
Para o fluxo completo de verificacao, a string canonica assinada e um exemplo em Node, veja Assinatura.

Boas praticas do handler

  • Retorne qualquer 2xx rapidamente.
  • Processe trabalho pesado de forma assincrona.
  • Deduplique por id do evento.
  • Persista o payload bruto para debugging e replay.

Paginas relacionadas