event registra algo que aconteceu em um recurso da sua conta: um cliente
foi criado, uma cobrança foi aprovada, uma assinatura foi cancelada.
Cada acontecimento gera um event. Esse event existe independente de você ter
endpoints de webhook configurados. Se houver endpoints inscritos, a Chargefy cria
entregas separadas para cada endpoint; se não houver, o event continua disponível
para consulta pela API.
Use events para conciliar o estado do seu sistema com a Chargefy. Use entregas de
webhook para debugar envio, retry, status HTTP e resposta do seu endpoint.
event e entrega de webhook são coisas diferentes. O event é o acontecimento;
a entrega é uma tentativa de enviar esse acontecimento para um endpoint.Como usar
| Preciso… | Use |
|---|---|
| Saber o que aconteceu | type |
| Processar sem duplicar trabalho | id do event |
| Ler o recurso no estado atual | data.object |
| Saber o que mudou em um update | data.previous_attributes |
| Saber de qual organização veio | organization |
| Investigar falha de envio HTTP | logs de entrega em Webhooks |
type.
Objeto event
ID único do event (
evt_*). Use esse valor como chave de idempotência no seu
sistema: se o mesmo event chegar mais de uma vez por retry, processe apenas
uma vez.Sempre
event.Timestamp ISO 8601 de quando o acontecimento foi registrado.
Contém o objeto afetado e, em eventos de atualização, o que mudou.
true para eventos do ambiente de produção, false para o de teste.Organização que originou o evento. Em integrações de plataforma, esse campo
aponta para a organização conectada onde o acontecimento ocorreu.
Referência à chamada de API que originou o evento, quando aplicável.
Tipo do evento, ex.:
customer.updated. Veja a
lista completa.Event vs entrega de webhook
Um event pode ter zero, uma ou várias entregas:| Cenário | Resultado |
|---|---|
| Nenhum endpoint inscrito | O event é criado e aparece na API, mas não há entrega. |
| Um endpoint inscrito | O event é criado e uma entrega é enviada para esse endpoint. |
| Vários endpoints inscritos | O event é criado uma vez e cada endpoint recebe sua própria entrega. |
/v1/events; você investiga tentativas HTTP nas telas e logs de Webhooks.
