---
schema_version: "1"
id: c3a603b6d39c6ffe01a5d3b00dd93b581518331424744c246205da83d9c8ad96
title: Record Alerts
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/financial_services/references/generated-api-specs/record_alerts.md
canonical_url: https://developer.salesforce.com/docs/industries/fsc/references/record_alerts
source_site: developer.salesforce.com
content_type: documentation
content_hash: 0e87fcd2b16bfbcb328c370545c6717fd95824dbddc0fcb050357c5d3069d85a
products:
  - Agentforce Financial Services
  - Industries Integrations
---
Record Alerts

# Record Alerts

API to get Record Alerts

Protocols: HTTP.

## Operations

### GET Retrieve record alerts

`GET /RecordAlerts/{id}/alerts`

Retrieves the alerts on a record.

#### Parameters

*   `id` (path, string, required) Specifies the ID provided by Salesforce.

#### Responses

*   **200**
    
    Media type: `application/json`. Schema: `GetAlertsSuccessResponse`.
    
*   **400**
    
    Media type: `application/json`. Schema: `GetAlertsErrorResponse`.
    
*   **401** Unauthorized
*   **404** Not Found
*   **429** Too many requests
*   **500** Internal Server Error
    
    Media type: `application/json`. Schema: `GetAlertsErrorResponse`.
    

### POST Perform record actions

`POST /RecordAlerts/{id}/actions`

Perform action on record

#### Parameters

*   `id` (path, string, required) Specifies the ID provided by Salesforce.

#### Responses

*   **200**
    
    Media type: `application/json`. Schema: `GetAlertsSuccessResponse`.
    
*   **400**
    
    Media type: `application/json`. Schema: `GetAlertsErrorResponse`.
    
*   **401** Unauthorized
*   **404** Not Found
*   **429** Too many requests
*   **500** Internal Server Error
    
    Media type: `application/json`. Schema: `GetAlertsErrorResponse`.
    

## Schemas

### GetAlertsSuccessResponse

Provides the record details returned by the GET method.

*   `RecordId` (_string_, required)  
    Example: `sourceSystemId1`.
*   `Alerts` (_array of object_, required)
    
    Each item: Specifies the alert details for a record.
    
    *   `RecordAlertId` (_string_, required)  
        Example: `123ABC`.
    *   `Subject` (_string_, required)  
        Example: `Low Balance Alert`.
    *   `Description` (_string_)  
        Example: `Low Balance detected on account ending in -4832`.
    *   `Severity` (_string_)  
        Example: `Warning`.
    *   `Actions` (_array of object_)
        
        Each item: Specifies the action details for an alert.
        
        *   `Name` (_string_, required)  
            Example: `Snooze`.

### GetAlertsErrorResponse

Specifies the response object for an error.

*   `ErrorCode` (_string_)  
    Example: `E-002`.
*   `ErrorMessage` (_string_, required)  
    Example: `error while retrieving alerts .`.
*   `MaintenanceResponse` (_object_)
    *   `timestamp` (_datetime (rfc3339)_)  
        Example: `2022-02-28T16:41:41.090Z`.