Skip to main content

​
Alert types

​
Managing alert states

Alerts are often tied to a specific plan or type of subscription. Accordingly, Orb allows you to configure alerts on the plan itself and automatically propagates them to all subscriptions of that plan. This allows you to quickly add an alert to an existing plan without having to run a migration over existing subscriptions. Similarly, when an alert is disabled, this change applies to all subscriptions. Note that alerts can be created, enabled, disabled, or modified either through the Orb UI (at the plan or subscription level) or through the API. Plan alerts It’s often useful to set ad hoc alerts for specific customers (especially when dealing with Enterprise contracts), so alerts can also be managed at the individual subscription level. Orb’s subscription card allows you to view alerts inherited from the plan and change them for the specific subscription instance. With this workflow, you can create alerts that correspond to a customer’s usage patterns, even if they differ from other subscriptions to the same plan. Inherited alerts

​
Viewing triggered alerts

Each subscription card on the customer page in Orb shows which alerts have been triggered during the current billing period, and the time at which the threshold was exceeded. Alerts view

​
Evaluation mechanics & SLAs

Most alerts and related usage monitoring actions like threshold invoicing and automatic top‑ups are evaluated in real-time, allowing you to build spend management workflows integrated into your product experience that are nearly instantaneous. Orb also supports periodic evaluation for more complex metrics, even allowing you to set up alerting over metrics that require a view of the full billing period to evaluate. In this case, the alert is evaluated periodically, and the Orb dashboard will indicate the difference in evaluation cadence eligibility. Note that an alert that composes multiple metrics (e.g. a balance alert that depends on drawdowns on all metrics or an invoice costs alerts that depends on the sum of all line items) will still be evaluated in real-time on the basis of the metrics that support incremental computation. In other words, if a large majority of your usage comes from simple, incrementally computable metrics, the alert will be evaluated in near real-time. The Orb dashboard will indicate that a subset of metrics are incrementally computable and cause the alert to be evaluated in real-time.
Creating a new alert or modifying an existing alert’s thresholds immediately invalidates the customer so the alert is re‑evaluated on the appropriate path, but this may take several minutes to complete.

​
Consuming alerts via webhooks

All alerts generate a webhook event when they fire, and your system can use this event to trigger actions. If several thresholds are crossed in rapid succession, Orb sends only the event for the highest threshold. Grouped cost alerts instead emit a single subscription.grouped_cost_exceeded event that batches every group that crossed a threshold in the same evaluation, so handle its groups array rather than expecting one event per group.