@rewritetoday/elysia e o adapter da Rewrite para apps Elysia que querem uma rota de webhook nativa com pouca cerimonia.
Repositorio: github.com/RewriteToday/adapters
Quando usar
- Quando seu backend ja usa roteamento e handlers do Elysia.
- Quando quer um adapter orientado ao framework em vez de montar a verificacao manualmente.
- Quando prefere callbacks tipados a codigo customizado de parse de webhook.
- Quando quer uma fronteira clara, no nivel da rota, para eventos de entrada da Rewrite.
Capacidades principais
Rota nativa do Elysia
Registre um endpoint de webhook com o mesmo estilo
app.post(...) que voce ja usa no Elysia.Validado antes do dispatch
A validacao da assinatura roda antes do payload chegar na sua logica de negocio.
Hooks de evento tipados
Trate familias especificas com callbacks nomeados ou processe tudo com
onPayload.Sem cola extra
O pacote ja esta pronto para uso com Elysia, sem dependencias extras para webhook.
Instalacao
Exemplo basico
Boas praticas
Mantenha o segredo apenas no servidor
Mantenha o segredo apenas no servidor
Carregue o segredo de assinatura a partir de variaveis de ambiente e mantenha esse valor separado de qualquer configuracao exposta ao cliente.
Trate a rota como fronteira de entrada
Trate a rota como fronteira de entrada
Sempre que possivel, deixe a logica de negocio fora do callback da rota para manter verificacao, logging e processamento posteriores mais simples.
Deduplique entregas em retry
Deduplique entregas em retry
Webhooks da Rewrite podem ser reenviados. Armazene o id do evento e torne os efeitos colaterais idempotentes.
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 o ponto de integracao certo para sua stack.
Visao geral de Webhooks
Formato da entrega, validacao de assinatura, semantica de retry e orientacoes de registro.
Tipos de evento
Guias de payload para
sms.otp e eventos do ciclo de vida de mensagens.