TenantConsumptionAlert

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update()

Fields

Field	Details
AlertScope	Type string Properties Filter, Group, Sort Description Required. Identifies the top-level resource or component that the alert applies to. AlertScope, AlertSubScope1, and AlertSubScope2 together identify the exact target of the alert, from broadest to most specific.
AlertStatus	Type picklist Properties Filter, Group, Sort Description Required. Indicates whether the alert condition is still active or has resolved (Active or Cleared). `Active` suppresses duplicate alerts while the condition persists. `Cleared` resets the alert so it can fire again.
AlertSubScope1	Type string Properties Filter, Group, Sort, Nillable Description Identifies a sub-resource or sub-component beneath the alert scope. Can be empty if no further refinement is required.
AlertSubScope2	Type string Properties Filter, Group, Sort, Nillable Description Identifies a sub-resource or sub-component that further refines AlertSubScope1. Can be empty if no further refinement is required. However, if you set AlertSubScope2, we recommend that you also set AlertSubScope1.
AlertTimestamp	Type dateTime Properties Filter, Group, Sort Description Required. The date and time the alert was triggered.
AlertType	Type string Properties Filter, Group, Sort Description Required. Identifies the type of signal that triggered the alert. Salesforce-managed alert types are prefixed with `sf__`.
IsNotificationSent	Type boolean Properties Filter, Group, Sort Description Required. Indicates whether a platform notification has been sent for this alert record (true) or not (false).
TriggerType	Type string Properties Filter, Group, Sort Description Required. The unit or measurement type of the value that triggered the alert, such as a percentage or unit count. Use this field to interpret the numeric value in TriggerValue. Values are: `ThresholdPercent` or `ThresholdUnits`.
TriggerValue	Type int Properties Filter, Group, Sort Description Required. The numeric value that triggered the alert, which is interpreted in the context of TriggerType.

Usage

TenantConsumptionAlert stores a record each time a utilization signal is reached for your org's consumption-based products or license utilization. Each record represents a single triggered signal and is structured hierarchically:

AlertType identifies the high-level signal category.

AlertScope (and its sub-scopes) identifies the specific resource that triggered the signal.
TriggerType and TriggerValue define the condition that was met.

There are two types of alerts: Salesforce-managed and user-defined.

Salesforce-managed alerts are created by Salesforce processes via invocable actions. Alert types for these alerts are prefixed with sf__. Salesforce validates that the triggering condition is correct on creation and provides out-of-the-box features, including flow templates and invocable actions, to manage the alert lifecycle. Lifecycle fields such as AlertStatus and IsNotificationSent are updated automatically.
User-defined alerts offer the flexibility to define any signal that meets your use case. However, all fields must be set manually. Lifecycle fields like AlertStatus and IsNotificationSent aren’t updated automatically.

About Salesforce-Managed Alert Types

Consumption Threshold alerts are triggered when consumption of a Digital Wallet consumption card reaches a specified threshold. For setup information, see Salesforce Help: Get Digital Wallet Notifications about Your Usage.

This table illustrates an alert for when the Data Services Credits consumption card exceeds 70% of its credits consumption based on its entitlements.

For this object, consumption cards are identified by their card definition developer name, which often differs from their display name in Digital Wallet. To determine the developer name for a consumption card, see “Find the Card Definition Developer Name” in Salesforce Help: Change a Consumption Threshold for a Specific Card.

Note

Field	Value
AlertType	sf__ConsumptionThreshold
AlertStatus	Active
AlertScope	The developer name for the consumption card, for example, PlatformServicesCard.
AlertSubScope1	Business environment (always Production)
AlertSubScope2	PrePurchased. Buying models include PrePurchased, PreCommitted, or PayGo, but not all consumption cards support all buying models.
TriggerType	ThresholdPercent
TriggerValue	70
AlertTimestamp	Date and time alert was triggered.
IsNotificationSent	true

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object.

TenantConsumptionAlertOwnerSharingRule: Sharing rules are available for the object.
TenantConsumptionAlertShare: Sharing is available for the object.

Object Reference for the Salesforce Platform

Supported Calls

Fields

Usage

About Salesforce-Managed Alert Types

Associated Objects

See Also