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

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

string

required

The ID of the customer whose usage alert was triggered.

string

required

The feature ID the alert applies to.

string

The entity ID the alert applies to, if the usage was entity-scoped.

object

required

Details of the usage alert that was triggered.

Show properties

string

User-defined label for the alert, if provided.

number

required

The threshold value that was crossed.

'usage' | 'usage_percentage' | 'remaining' | 'remaining_percentage'

required

Whether the threshold is an absolute usage count or a percentage.

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

Show child attributes

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.

⌘I

Billing

Balances

Customers

Authorization

Events

Entities

Plans

Features

Rewards & Referrals

Webhook Events

Platform (Beta)

Usage Alert Triggered

Payload Fields

Authorizations

Body

Response

​Payload Fields

Authorizations

Body

Response

Payload Fields