You are here:
Create Consumption Alert
Sends a notification to specified users when consumption for a card meets or exceeds a specified threshold.
Set Input Values
| Field | Description |
|---|---|
| Alert Trigger Type | Required. The type of threshold that triggers the alert. Valid values are:
|
| Alert Trigger Value | Required. The numeric threshold that was crossed, either the percent or the unit count, depending on the alert trigger type. |
| Business Environment Type | Required. The environment type of the org that triggered the usage. Valid values are: |
| Card Definition Developer Name | Required. The developer name for the Digital Wallet consumption card that you're raising an alert for. This name is often different from the display name. See Salesforce Help: Change a Consumption Threshold for a Specific Card for information on how to map the card definition developer name to the display name. |
| Recipient IDs | The list of user IDs for the recipients who are notified. You can pass up to 1000.
Required when Send Notification is true. |
| Send Notification | Optional. If true, notifies recipients when the alert is created; if
false, creates the alert without sending notifications. Defaults to
true. |
| Usage Model | Required. The buying model for the contract. Valid values are: |
Set Output Values
| Field | Description |
|---|---|
| Is Created | Indicates whether the alert was created (true) or not
(false). |
| Message | The explanation of why the alert wasn't created. When the alert is created, this field is empty. |
Usage
Use Create Consumption Alert to record a usage alert for a consumption card when consumption
meets or exceeds a threshold, and to optionally notify users. Commonly, a Compute Consumption
action is followed with a Decision element that checks each card's usage, then calls Create
Consumption Alert when a threshold is crossed. Set Send Notification to
true and provide Recipient IDs to notify users, or set it to
false to record the alert without sending notifications. After the action
runs, a check Is Created to confirm the alert was recorded. Use
Message to handle or log the reason when it wasn't. Is
Created is false if the threshold specified isn’t exceeded by the
provided consumption card. For example, the consumption card’s usage is at 12% but you attempted
to trigger a consumption alert at 80%.
