credits.low

Docházejí kredity

Zůstatek kreditů za období překročil práh čerpání (data.threshold – procento vyčerpaného přídělu). Odesílá se jednou pro každý práh a období.

Typ objektu: org
Komu se doručuje: Webhookům s rolí administrátora

Obsah události

Objekt: EventCreditsLow

idstringpovinné
ID události (evt_…), posílá se také jako hlavička webhook-id. Podle něj zahazujte duplicitní doručení.
typestringpovinné
Povolené hodnoty: credits.low
created_atstring (date-time)povinné
Kdy ke změně došlo (UTC).
org_idintegerpovinné
api_versionstringpovinné
Verze kontraktu schématu data.
sequenceinteger
Pořadové číslo doručení v rámci webhooku (u testovací události chybí).
objectWebhookEventObjectpovinné
payloadstringpovinné
thin znamená bez data: objekt si přečtěte přes API.
Povolené hodnoty: fullthin
dataobject
Pole
- thresholdintegerpovinné
  Práh v procentech vyčerpaného přídělu: 80 nebo 100.
- period_startstring (date)povinné
- balancenumber
- allowancenumber
testbooleanpovinné
Testovací událost odeslaná pomocí POST /v1/webhooks/{webhook_id}/test.

Ukázka doručení

{
  "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
}

Příjem událostí

Každé doručení je požadavek POST s tímto tělem JSON na adresu vašeho příjemce. Než tělu začnete důvěřovat, ověřte hlavičku webhook-signature (Standard Webhooks), do několika sekund odpovězte stavovým kódem 2xx a samotnou práci udělejte až potom. Doručení na jeden webhook zachovávají pořadí událostí; neúspěšné doručení se opakuje s rostoucími pauzami.

Nové typy událostí a nová pole se mohou objevit kdykoli: typy a pole, které neznáte, přeskočte.

Stejné události najdete 30 dní v kanálu událostí →