Skip to main content
WEBHOOK
balances.usage_alert_triggered
{
  "type": "balances.usage_alert_triggered",
  "data": {
    "customer_id": "org_123",
    "feature_id": "api_calls",
    "entity_id": "workspace_abc",
    "usage_alert": {
      "name": "80% usage warning",
      "threshold": 80,
      "threshold_type": "usage_percentage_threshold"
    }
  }
}

​
Payload Fields

​
customer_id
string
required
The ID of the customer whose usage alert was triggered.
​
feature_id
string
required
The feature ID the alert applies to.
​
entity_id
string
The entity ID the alert applies to, if the usage was entity-scoped.
​
usage_alert
object
required
Details of the usage alert that was triggered.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
type
string
required

The webhook event type.

Allowed value: "balances.usage_alert_triggered"
​
data
object
required
Example:
{
  "customer_id": "org_123",
  "feature_id": "api_calls",
  "entity_id": "workspace_abc",
  "usage_alert": {
    "name": "80% usage warning",
    "threshold": 80,
    "threshold_type": "usage_percentage_threshold"
  }
}

Response

200

Webhook received successfully.