Alert
Create customer alert
This endpoint creates a new alert to monitor a customer’s credit balance. There are three types of alerts that can be scoped to
customers: credit_balance_depleted
, credit_balance_dropped
, and credit_balance_recovered
. Customers can have a maximum
of one of each type of alert per credit balance currency.
credit_balance_dropped
alerts require a list of thresholds to be provided while credit_balance_depleted
and credit_balance_recovered
alerts do not require thresholds.
POST
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
application/json
Response
201
application/json
Created
Alerts within Orb monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded.
Alerts created through the API can be scoped to either customers or subscriptions.