credits.low

Payload

Objeto: EventCreditsLow

• idstringobrigatório

  ID do evento (evt_…), também enviado como cabeçalho webhook-id. Use-o para descartar entregas duplicadas.

• typestringobrigatório

  Valores permitidos: credits.low

• created_atstring (date-time)obrigatório

  Quando a alteração aconteceu (UTC).

• org_idintegerobrigatório
• api_versionstringobrigatório

  Versão do contrato do esquema data.

• sequenceinteger

  Número de sequência da entrega dentro do webhook (ausente em um evento de teste).

• objectWebhookEventObjectobrigatório
• payloadstringobrigatório

  thin significa sem data: leia o objeto pela API.

  Valores permitidos: fullthin

• dataobject
  Campos

  • thresholdintegerobrigatório

    Limite em porcentagem da franquia usada: 80 ou 100.

  • period_startstring (date)obrigatório
  • balancenumber
  • allowancenumber
• testbooleanobrigatório

  Um evento de teste enviado por POST /v1/webhooks/{webhook_id}/test.

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "credits.low",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "org",
    "id": "1"
  },
  "payload": "full",
  "data": {
    "threshold": 80,
    "period_start": "2026-10-01",
    "balance": 1000,
    "allowance": 5000
  },
  "test": false
}