Record Alerts (GET)

Retrieve a list of active record alerts.

Resource

1/recordalerts

Resource Examples

1https://yourInstance.salesforce.com/services/data/vXX.X/recordalerts
2?whatId=a0URO000000Ccbz2AC

1https://yourInstance.salesforce.com/services/data/vXX.Xrecordalerts
2?parentId=001RO000002JPkrYAG

1https://yourInstance.salesforce.com/services/data/vXX.Xrecordalerts
2?whatId=a0URO000000Ccbz2AC&parentId=001RO000002JPkrYAG

Available version

54.0

Requires Chatter

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

1{
2  "recordAlerts" : [ {
3    "actions" : {
4      "actionInfoCollection" : [ {
5        "actionName" : "dismiss",
6        "parameters" : [ ]
7      }, {
8        "actionName" : "snooze",
9        "parameters" : [ "effectiveDate" ]
10      } ]
11    },
12    "active" : true,
13    "description" : "Unauthorized transaction on card ending with -XXXX on Nov. 11, 2021 in Rome, Italy",
14    "effectiveDate" : "2021-11-10T20:00:00.000Z",
15    "id" : "0qZRO000000003o",
16    "recordAlertCategoryName" : "Fraud",
17    "severity" : "Error",
18    "source" : "Internal",
19    "subject" : "Fraud Transaction 3",
20    "validUntilDate" : "2022-11-08T20:00:00.000Z",
21    "whatId" : "a0URO000000Ccbz"
22  }, {
23    "actions" : {
24      "actionInfoCollection" : [ {
25        "actionName" : "dismiss",
26        "parameters" : [ ]
27      }, {
28        "actionName" : "snooze",
29        "parameters" : [ "effectiveDate" ]
30      } ]
31    },
32    "description" : "Apex alert description from an external system",
33    "severity" : "Test",
34    "source" : "External",
35    "sourceSystemId" : "sourceSystemId",
36    "subject" : "Subject",
37    "whatId" : "a0URO000000Ccbz2AC"
38  } ]
39}

Industries Common Resources Developer Guide

Record Alerts (GET)