Direct naar de inhoud
Sursa Developers

Events · Facturering

credits.low

Credits bijna op

Het creditsaldo van de periode heeft een gebruiksdrempel overschreden (data.threshold, percentage van het verbruikte tegoed). Wordt één keer per drempel en periode verstuurd.

Objecttype
org
Geleverd aan
Webhooks met de rol admin

Payload

Object: EventCreditsLow

  • idstringverplicht

    ID van het event (evt_…), ook meegestuurd als header webhook-id. Gebruik die om dubbele leveringen te negeren.

  • typestringverplicht

    Toegestane waarden: credits.low

  • created_atstring (date-time)verplicht

    Wanneer de wijziging plaatsvond (UTC).

  • org_idintegerverplicht
  • api_versionstringverplicht

    Contractversie van het schema van data.

  • sequenceinteger

    Volgnummer van de levering binnen de webhook (ontbreekt bij een testevent).

  • objectWebhookEventObjectverplicht
  • payloadstringverplicht

    thin betekent geen data: lees het object via de API.

    Toegestane waarden: fullthin

  • dataobject
    Velden
    • thresholdintegerverplicht

      Drempel in procenten van het verbruikte tegoed: 80 of 100.

    • period_startstring (date)verplicht
    • balancenumber
    • allowancenumber
  • testbooleanverplicht

    Een testevent, verstuurd door POST /v1/webhooks/{webhook_id}/test.

Voorbeeldlevering

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

Events ontvangen

Elke levering is een POST-request met deze JSON-body naar het ontvangstadres van je webhook. Controleer de header webhook-signature (Standard Webhooks) voordat je de body vertrouwt, antwoord binnen een paar seconden met een 2xx-status en doe het werk daarna. Leveringen aan één webhook behouden de volgorde van de events; een mislukte levering wordt met steeds langere pauzes opnieuw geprobeerd.

Er kunnen op elk moment nieuwe eventtypes en nieuwe velden bij komen: sla de types en velden over die je niet kent.

Dezelfde events staan 30 dagen in de eventfeed →