@rewritetoday/express e o adapter da Rewrite para apps Express que precisam de um endpoint de webhook nativo do framework com setup minimo.
Repositorio: github.com/RewriteToday/adapters
Quando usar
- Quando sua aplicacao ja usa roteamento e middleware do Express.
- Quando quer que o adapter cuide do raw body necessario para validar assinaturas.
- Quando prefere callbacks nomeados a parse manual de request.
- Quando precisa de uma rota de entrada dedicada e validada para webhooks da Rewrite.
Capacidades principais
Middleware nativo do Express
Monte o handler de webhook direto em
app.post(...) com o formato de middleware esperado pelo Express.Tratamento de raw body
O adapter ja gerencia o corpo bruto da request exigido para a verificacao da assinatura.
Callbacks tipados
Trate eventos suportados da Rewrite com hooks nomeados ou use
onPayload para roteamento generico.Validado antes da logica de negocio
A verificacao da assinatura roda antes da sua aplicacao acessar o payload.
Instalacao
Exemplo basico
Boas praticas
Use uma rota dedicada para o webhook
Use uma rota dedicada para o webhook
Mantenha o endpoint da Rewrite isolado de middlewares JSON genericos para que o tratamento de raw body continue previsivel.
Retorne 2xx rapidamente
Retorne 2xx rapidamente
Confirme a entrega assim que possivel e mova trabalho demorado para filas, jobs ou processadores em background.
Deduplique pelo id do evento
Deduplique pelo id do evento
Armazene o id do webhook e torne efeitos colaterais idempotentes para que retries sejam seguros.
Callbacks de evento disponiveis
Callbacks de evento disponiveis
O adapter suporta
onSMSOTP, onMessageSent, onMessageBatch, onMessageQueued, onMessageDelivered, onMessageScheduled, onMessageFailed, onMessageCanceled e o hook generico onPayload.Documentacao relacionada
Visao geral de Adapters
Compare os adapters oficiais e escolha a superficie de integracao certa.
Visao geral de Webhooks
Formato da entrega, validacao de assinatura, retries e orientacoes operacionais.
Tipos de evento
Guias de payload para todos os eventos de webhook suportados pela Rewrite.