1. Concepts
What Usage Alerts does
Communications > Usage Alerts configures webhook notifications that fire when a customer’s usage of an entitlement crosses a threshold. Today, Zenskar supports entitlement-usage alerts only; other alert types are not yet available.How a threshold is defined
An alert is scoped to a single entitlement. Its threshold is defined by a Consumption value together with a Value Type of either Units or Percentage. When a customer’s usage of the selected entitlement reaches the configured consumption, the alert fires.Delivery is webhook-only, and can target more than one webhook
An alert can be linked to one or more webhooks, all of which receive a notification when the alert fires. Webhooks are managed separately, under Settings > Webhook Alerts, though a new webhook can also be created inline while building an alert, without leaving the page.Alert status
Each alert has a status of active or inactive. An alert fires only while active. Setting an alert to inactive keeps its configuration but stops it from firing until it is set back to active.2. How-to guides
Create a usage alert
- Go to Communications > Usage Alerts, and click + Add Usage Alert.
- Enter an Alert Name.
- Select the Entitlement this alert applies to.
- Set Consumption and Value Type (Units or Percentage) to define the threshold that triggers the alert.
- Select one or more Webhooks to notify. Use Add New Webhook if the webhook does not exist yet.
- Click Save Usage Alert.
View usage alerts
Go to Communications > Usage Alerts. The list shows every alert with its name, alert type, status, and creation date.Edit a usage alert
- Go to Communications > Usage Alerts, and select the alert to change.
- Update any of the fields described in Create a usage alert.
- Click Save Usage Alert.
Turn a usage alert off or back on
Open the alert’s actions menu, and use Pause to set it to inactive, or Resume to set an inactive alert back to active. The menu label switches between Pause and Resume depending on the alert’s current status.Delete a usage alert
Open the alert’s actions menu, and use Delete. Confirm the action when prompted.Troubleshooting
- The Webhook dropdown is empty: no webhook has been created yet. Use Add New Webhook from within the alert form, or go to Settings > Webhook Alerts to create one first.
- An alert stopped firing: check its status. A status of inactive means the alert keeps its configuration but does not fire until it is set back to active.