Skip to main content
Os adapters da Rewrite sao handlers de webhook conscientes do framework e do runtime, mantidos pela propria equipe da Rewrite. Eles verificam assinaturas, fazem o parse seguro do payload e expoem callbacks tipados que combinam com a forma como sua stack ja lida com requests de entrada.

Por que adapters?

Nativos do framework

Monte handlers de webhook diretamente em Express, Fastify, Elysia, Hono ou em runtimes edge padrao.

Seguranca por padrao

A verificacao da assinatura acontece antes do payload chegar na sua logica de negocio.

Eventos tipados

Trate sms.otp e eventos do ciclo de vida de mensagens com callbacks nomeados ou com um hook generico.

Menos boilerplate

Evite parsing manual de raw body, cola de rota e codigo repetitivo de validacao de webhook.

Catalogo de adapters

Edge

Tratamento padrao com Request e Response para workers e runtimes edge.

Elysia

Rotas de webhook nativas para apps Elysia com setup minimo.

Express

Integracao com middleware do Express e raw body necessario para validar assinaturas.

Fastify

Registro por plugin para servicos Fastify que querem uma fronteira limpa para webhooks.

Hono

Handlers enxutos para apps Hono rodando em edge ou runtimes compativeis com Node.

Adapter, SDK ou pacote?

Comece pelo adapter que combina com sua stack HTTP. Ele oferece a menor superficie de integracao e reduz o boilerplate especifico de webhooks.
Use um SDK oficial ou @rewritetoday/rest. Adapters sao focados em verificacao de webhook e dispatch de eventos de entrada.
Use os pacotes base do ecossistema diretamente quando voce so precisa de contratos, validacao ou primitivas de transporte e prefere montar a rota por conta propria.

Fluxo comum

  1. Instale o adapter que combina com seu framework ou runtime.
  2. Leia o segredo do webhook a partir de variaveis de ambiente ou bindings da plataforma.
  3. Registre um handler POST para o endpoint de webhook da Rewrite.
  4. Trate eventos especificos com callbacks nomeados ou use onPayload para roteamento generico.
  5. Retorne 2xx rapidamente e mova o trabalho pesado para filas ou tarefas em background.

Callbacks disponiveis

Todos os adapters oficiais expoem a mesma superficie de callbacks:
  • onSMSOTP
  • onMessageSent
  • onMessageBatch
  • onMessageQueued
  • onMessageDelivered
  • onMessageScheduled
  • onMessageFailed
  • onMessageCanceled
  • onPayload
Adapters sao para consumidores de webhook. Mantenha REWRITE_API_KEY fora do endpoint de webhook e armazene ali apenas o segredo de assinatura.

Documentacao relacionada

Visao geral de Webhooks

Formato da entrega, validacao de assinatura, retries e registro de webhooks.

Tipos de evento

Familias de payload e paginas por evento para sms.otp e ciclo de vida de mensagens.

Repositorio Adapters

Codigo-fonte, exemplos e historico de releases de todos os adapters oficiais.