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.

Record Alerts (GET)

Retrieve a list of active record alerts.
Resource
Resource Examples
Available version
54.0
Requires Chatter
No
HTTP methods
GET
Query parameters for GET
Parameter Name Type Description Required or Optional Available Version
parentId String The related parent record ID on which a record alert is created. Optional 54.0
whatId String The Salesforce object record ID on which a record alert is created.

For external alerts, whatId can be any valid Salesforce ID. For internal alerts, whatId can only be polymorphic objects including all custom objects.

Note

Supported polymorphic objects are:
  • Account
  • Asset
  • BusinessMilestone
  • Campaign
  • Contract
  • Contact
  • Case
  • Claim
  • InsurancePolicy
  • InsurancePolicyCoverage
  • InteractionSummary
  • Lead
  • LoanApplication
  • LoanApplicantEmployment
  • LoanApplicantIncome
  • LoanApplicationProperty
  • LoanApplicationFinancial
  • LoanApplicationAsset
  • LoanApplicationLiability
  • Opportunity
  • PersonLifeEvent
  • ResidentialLoanApplication
  • All Custom Objects
Required 54.0
Response body for GET
Record Alert Collection
JSON example of response body