Eventos

Os webhooks são acionados por eventos específicos ocorridos no sistema, enviando automaticamente um payload com os dados relevantes para o endpoint configurado. Cada evento possui:


Um identificador único:

exemplo: payment.approved, order.completed.


Dados contextualizados:

exemplo: ID do pedido, status, valor, horário.

Assinatura digital para validação de autenticidade.


Tipos Comuns de Eventos (Exemplos):

Pagamentos: charge.created, refund.processed.

Pedidos: order.shipped,canceled.

Usuários: user.registered, account.updated.


📘

Como Funciona?

  • Configuração: Você define quais eventos deseja escutar e o endpoint de recebimento.

  • Disparo: Quando o evento ocorre, o sistema envia uma requisição HTTP POST com o payload em JSON.

  • Processamento: Seu servidor valida a assinatura e executa a lógica desejada (ex.: atualizar banco de dados, enviar e-mail).

Os eventos disponíveis e seus payloads serão detalhados nas próximas seções.