credits.low

Krediiti on vähe

Perioodi krediidisaldo ületas kasutuse läve (data.threshold, kasutatud protsent sisalduvast mahust). Saadetakse iga läve ja perioodi kohta üks kord.

Objekti tüüp: org
Vastuvõtvad veebihaagid: Veebihaagid, millel on roll admin

Sisu

Objekt: EventCreditsLow

idstringkohustuslik
Sündmuse ID (evt_…), mis saadetakse ka päisena webhook-id. Kasutage seda topeltedastuste kõrvaldamiseks.
typestringkohustuslik
Lubatud väärtused: credits.low
created_atstring (date-time)kohustuslik
Millal muudatus toimus (UTC).
org_idintegerkohustuslik
api_versionstringkohustuslik
Skeemi data lepingu versioon.
sequenceinteger
Edastuse järjekorranumber veebihaagi piires (testsündmuse puhul puudub).
objectWebhookEventObjectkohustuslik
payloadstringkohustuslik
thin tähendab, et välja data ei ole: lugege objekti API kaudu.
Lubatud väärtused: fullthin
dataobject
Väljad
- thresholdintegerkohustuslik
  Lävi protsentides kasutatud sisalduvast mahust: 80 või 100.
- period_startstring (date)kohustuslik
- balancenumber
- allowancenumber
testbooleankohustuslik
Testsündmus, mille saatis POST /v1/webhooks/{webhook_id}/test.

Näidisedastus

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

Sündmuste vastuvõtmine

Iga edastus on selle JSON-kehaga POST-päring teie veebihaagi URL-ile. Enne keha usaldamist kontrollige päist webhook-signature (Standard Webhooks), vastake mõne sekundi jooksul olekuga 2xx ja tehke töö ära hiljem. Ühe veebihaagi edastused säilitavad sündmuste järjekorra; ebaõnnestunud edastust proovitakse uuesti üha pikemate vahedega.

Uued sündmusetüübid ja uued väljad võivad ilmuda igal ajal: jätke tundmatud tüübid ja väljad vahele.

Samad sündmused on 30 päeva jooksul sündmuste lindis →