Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.atriby.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks permitem que a Atriby envie eventos de pedido para o seu servidor.

O que funciona hoje

  • Criar, listar e desabilitar endpoints no app.
  • Entrega HTTP POST real para a URL configurada.
  • Assinatura HMAC-SHA256.
  • Logs de entrega.
  • Retry manual de falhas.

Eventos suportados

EventoQuando dispara
order.createdUm pedido é criado via POST /api/v1/orders.
order.paidUm pedido muda para paid.
order.refundedUm pedido muda para refunded.
order.chargebackUm pedido muda para chargedback.
order.refused não dispara webhook hoje.

Rotas do app

As rotas de gerenciamento usam sessão do dashboard, não API token:
MétodoRotaUso
GET/api/webhooksLista endpoints e entregas recentes.
POST/api/webhooksCria endpoint e retorna o segredo uma vez.
DELETE/api/webhooks/{id}Desabilita endpoint.
POST/api/webhooks/deliveries/{id}/retryReenvia entrega manualmente.

Limites atuais

  • Não existe PATCH /api/webhooks/{id}. Para alterar URL, nome ou eventos, desabilite e crie outro endpoint.
  • Não há worker, fila ou backoff automático.
  • Retry é manual.
  • Webhooks fora do domínio de pedidos ainda não existem.