Skip to main content
Um 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

Events e seus payloads não têm expiração automática. Eles permanecem disponíveis para consulta, auditoria e debug. Veja Entrega de webhooks para o formato de entrega e Tipos de evento para a lista completa de type.

Objeto event

string
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.
string
Sempre event.
string
Timestamp ISO 8601 de quando o acontecimento foi registrado.
object
Contém o objeto afetado e, em eventos de atualização, o que mudou.
boolean
true para eventos do ambiente de produção, false para o de teste.
string | null
Organização que originou o evento. Em integrações de plataforma, esse campo aponta para a organização conectada onde o acontecimento ocorreu.
object
Referência à chamada de API que originou o evento, quando aplicável.
string
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: Essa separação evita duplicação no ledger de events. Você lista acontecimentos em /v1/events; você investiga tentativas HTTP nas telas e logs de Webhooks.

Catálogo de eventos

Todos os tipos públicos e links para os payloads individuais.

Entrega e assinatura

Headers, timeout, retries, duplicação, ordem e fan-out.