Skip to main content
Make sure to read the Webhooks Overview for important information about signature verification.

​
Purpose

The usage.threshold.exceeded.units webhook is triggered when a customer’s usage of a brick reaches a set number of units in the current billing period, e.g. 1,000 API calls this month. Configure the unit thresholds on the brick under Usage alerts. See Usage Alerts for setup.

​
When it fires

  • Usage is the brick’s total units in the current billing period.
  • It fires once per threshold in each billing period. If one usage record crosses several thresholds, one event is sent for each threshold crossed.
  • Usage pools do not send it. Use usage.threshold.exceeded.precommitment for pools.
Only usage in the current billing period is checked. Backfilling usage for an earlier period does not send this webhook.

​
Payload format

Your configured endpoint will receive a Usage Threshold payload with alerting_target_type set to units. Both values are units of the brick.