Objects

EventCreditsLow

Fields

• idstringrequired

  Event ID (evt_…), also sent as the webhook-id header. Use it to drop duplicate deliveries.

• typestringrequired

  Allowed values: credits.low

• created_atstring (date-time)required

  When the change happened (UTC).

• org_idintegerrequired
• api_versionstringrequired

  Contract version of the data schema.

• sequenceinteger

  Delivery sequence number within the endpoint (absent for a test event).

• objectWebhookEventObjectrequired
• payloadstringrequired

  thin means no data: read the object through the API.

  Allowed values: fullthin

• dataobject
  Fields

  • thresholdintegerrequired

    Threshold in percent of the allowance used: 80 or 100.

  • period_startstring (date)required
  • balancenumber
  • allowancenumber
• testbooleanrequired

  A test event sent by POST /v1/webhooks/{webhook_id}/test.

Payload of events

credits.low