Spark!

Webhooks

Receba notificações de eventos em tempo real

Última atualização: 2026-01-19

Os webhooks notificam seu aplicativo quando ocorrem eventos no Spark!. Receba atualizações em tempo real sobre novos pedidos, cadastros de afiliados, pagamentos e mais.

Configuração de webhooks

  1. Acesse Settings → API → Webhooks
  2. Clique em "Add Webhook Endpoint"
  3. Insira a URL do seu endpoint (HTTPS obrigatório)
  4. Selecione os eventos que deseja receber
  5. Copie o segredo de assinatura para verificação

Eventos disponíveis

  • affiliate.created — Novo afiliado cadastrado
  • affiliate.approved — Afiliado aprovado
  • affiliate.updated — Perfil de afiliado alterado
  • order.attributed — Pedido atribuído ao afiliado
  • commission.created — Comissão calculada
  • commission.approved — Comissão confirmada
  • commission.paid — Comissão paga
  • payout.created — Lote de pagamentos criado
  • payout.completed — Lote de pagamentos processado
  • click.recorded — Clique em link de afiliado

Formato do payload

Os payloads dos webhooks são objetos JSON com:

  • id — ID único do evento
  • type — Tipo de evento (por exemplo, "order.attributed")
  • created_at — Timestamp ISO 8601
  • data — Objeto de dados específico do evento
Idempotência

Use o campo id para eliminar eventos duplicados. Em casos raros, o mesmo evento pode ser entregue várias vezes.

Verificação de webhooks

Verifique as assinaturas dos webhooks para garantir a autenticidade:

  1. Extraia o cabeçalho X-Spark-Signature
  2. Calcule o HMAC-SHA256 do corpo bruto usando seu segredo de assinatura
  3. Compare a assinatura calculada com o valor do cabeçalho
  4. Rejeite solicitações que não correspondam

Política de novas tentativas

Se o endpoint falhar (resposta fora da faixa 2xx), o Spark! tenta novamente:

  • Imediatamente
  • Após 5 minutos
  • Após 30 minutos
  • Após 2 horas
  • Após 24 horas

Após 5 tentativas com falha, o webhook é marcado como falho.

Testes de webhooks

Teste seu endpoint de webhook:

  • Use o botão "Send Test Event" nas configurações
  • Veja os logs de entrega dos webhooks
  • Repita manualmente as entregas com falha

Próximos passos

Esta página foi útil?

Precisa de mais ajuda? Fale com o suporte