Skip to main content
Cria um novo endpoint de webhook para receber notificações de eventos em tempo real.

Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization.

Parâmetros do Body

ParâmetroTipoObrigatórioDescrição
urlstringSimURL do endpoint que receberá os eventos
eventsarraySimLista de eventos a escutar (ex: subscription.created, subscription.canceled)
secretstringNãoSecret para validação de assinatura (gerado automaticamente se omitido)
organizationIdstringSimID da organização

Campos da Resposta

CampoTipoDescrição
idstringID do endpoint
urlstringURL do endpoint
eventsarrayLista de eventos
secretstringSecret para validação
statusstringStatus (active, disabled)
createdAtdatetimeData de criação

Exemplo de Requisição

curl -X POST "https://api.chargefy.io/api/v1/webhook-endpoints/" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://meusite.com.br/webhooks/chargefy",
    "events": ["subscription.created", "subscription.canceled", "checkout.updated"],
    "organizationId": "org_abc"
  }'

Exemplo de Resposta

{
  "id": "we_abc123",
  "url": "https://meusite.com.br/webhooks/chargefy",
  "events": ["subscription.created", "subscription.canceled", "checkout.updated"],
  "secret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "active",
  "organizationId": "org_abc",
  "createdAt": "2026-03-12T10:00:00Z"
}