Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B and D2C Commerce Actions
Cancel Approval Submission Action
Change Order Summary Preview
Change Order Summary Submit
Commerce Checkout Flow Actions
Convert Base64 Speech to Text Action
Create Service Document Actions
Create Service Report Actions
Custom Notification Actions
Deploy Data Kit Components Action
Digital Wallet Actions
Compute Consumption Action
Create Consumption Alert
Email Alert Actions
Einstein Bots Actions
Exit Individuals from a Flow Action
Explore Conversation Actions
Extract Data from Document Action
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Get Conversation Intelligence Action
Get Conversation Transcript Action
Get Data Graph Data By Lookup
Get Data Graph Metadata
Inbox Actions
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
Perform Survey Sentiment Analysis
PlatformAction
Post to Chatter Actions
Preview Cart to Exchange Order
Prompt Template Actions
Quick Actions
Reassign Approval Work Item Action
Recall Approval Submission Action
Refresh Metric Actions
Review Approval Work Item Action
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Conversation Messages Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Speech to Text Action
Submit Exchange Order
Submit for Approval Actions
Survey Invitation Actions
Text to Speech Action (Beta)
Work Plan and Work Step Actions
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Create Consumption Alert

Sends a notification to specified users when consumption for a card meets or exceeds a specified threshold. This object is available in API version 63.0 and later.

Available in: Enterprise Edition and Unlimited Edition orgs, or a Data One companion org of either edition, with Data 360 turned on.

Supported REST HTTP Methods

URI: /services/data/v63.0/actions/standard/createConsumptionAlert

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
alertTriggerType picklist Required. The type of threshold that triggers the alert: ThresholdPercent or ThresholdUnits.
alertTriggerValue int Required. The numeric threshold that was crossed to trigger the alert.
businessEnvType picklist Required. The environment type of the org that triggered the usage: Production or Sandbox.
cardDefinitionDeveloperName string 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 developer name to the card display name.
recipientIds ID (array, max 1000) Optional. The list of user IDs for the recipients being notified. Required when sendNotification is true.
sendNotification boolean Optional. If true, notifies recipients when the alert is created. If false, the alert is created without sending notifications. Defaults to true.
usageModel picklist Required. The buying model for the contract: PrePurchased, PayGo, PreCommitted, or Unlimited.

Outputs

Output Type Description
isCreated boolean Indicates whether the alert was created (true) or not (false). 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%.
message string The explanation of why the alert wasn't created. When the alert is created, this field is empty.