Alerts - Use Case and Examples

Use Cases

The end user wants to manage alerts. This management includes creating/updating/deleting/viewing alert types.

An alert type has alert templates. Alert templates can be created/updated/deleted/viewed. Alert Template APIs are designed to create and manage templates for different alert types for different channels (EMAIL, SMS, and PUSH). APIs will give flexibility to create FI-based/ default alert type templates for different channels. Once an alert type is created, it needs to be whitelisted.

Alert preferences opted by the user can be created/updated/deleted/viewed for a user. Alert Preference APIs are meant to deal with a user’s alert-related delivery preference. The user can opt his/her preference according to various channels (EMAIL, PUSH, and SMS) and alert types. After alert types and alert templates are managed, the alerts can be published. The Publish Event API takes the data in the requests and initiates the sending of the alert. The alert history can be viewed by using Alert History APIs.

The user in this use case above is the customer of financial institution.

Get the list of existing alert types
Get list of alert type resources based on multiple filters GET /digitalbanking/db-alerts-management/v1/alert-types

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI

Query Parameters:

AlertCategory: alert category to categorize alert types (e.g. BALANCE, BB, PAYMENTS, CARD, etc.)
AlertTypeName: alert type name that is unique in the system (e.g. ATM\_WITHDRAWAL, CORELATION\_LOWBAL, VISA\_LOWBAL)
ExternalSystem: optional externalSystem name in case of any TPV integrations
Creates an alert type for a financial institution
Create an alert type POST /digitalbanking/db-alerts-management/v1/alert-types

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Content-Type: application/JSON

Body

alertTypeName: a string, alert type name that is unique in system eE.g. - ATM\_WITHDRAWAL CORELATION\_LOWBAL, VISA\_LOWBAL). This is a required field.
alertTypeDomain: an enum, event type that associates to the respective inbound event. This is a required field.

Example: ACCOUNT, TRANSACTION, NOTIFICATION

externalSystem: a string, optional externalSystem name in case of any TPV integrations
status: status of the alert type ACTIVE or INACTIVE. his is a required field.
description: a string, description of alert type. This is a required field.
channels: a string, channels that are applicable for alertType (Default EMAIL, SMS, PUSH)
displayAlertTypeName: a string, display name is used for UI to display the alert type name

Sample Body:

{
"alertTypeName": "HIGHBAL",
"eventTypeDomain": "ACCOUNT",
"externalSystem": "CANDESCENT",
"status": "ACTIVE",
"description": "High balance alert",
"channels" : "EMAIL,SMS",
"displayAlertTypeName " : "High Balance Alert"
}

Updates an existing alert type for a Financial institution
Change an alert type PUT /digitalbanking/db-alerts-management/v1/alert-types

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Content-Type: application/JSON

Body

alertTypeId: long, alert type resource ID
alertTypeName: a string, alert type name that is unique in system (e.g. - ATM\_WITHDRAWAL, CORELATION\_LOWBAL, VISA\_LOWBAL). This is a required field.
alertTypeDomain: an enum, event type that associates to the respective inbound event. This is a required field.

Example: ACCOUNT, TRANSACTION, NOTIFICATION

externalSystem: a string, optional externalSystem name in case of any TPV integrations
status: status of the alert type ACTIVE or INACTIVE. This is a required field.
description: A string, description of alert type. This is a required field.
displayAlertTypeName: A string, display name is used for UI to display the alert type name

Sample Body:

{
"alertTypeId": 242,
"alertTypeName": "HIGHBALTEMP",
"eventTypeDomain": "ACCOUNT",
"externalSystem": "CANDESCENT",
"status": "ACTIVE",
"description": "High balance alert Description update" ,
"displayAlertTypeName " : "High Balance Alert"
}

Deletes a specific alert type created by the user
Delete Alert Type for ExternalSystem/Institution DELETE /digitalbanking/db-alerts-management/v1/alert-types/{id}

Request

Path Parameter:

ID: This is an alert type ID that was created.

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI

Body:

No body
Get the list of existing alert templates
Fetch the institution/default templates by various filters GET /digitalbanking/db-alerts-management/v1/alert-templates

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI

Query Parameters:

AlertTypeName: alert type name that is unique in the system (e.g. - ATM\_WITHDRAWAL, CORELATION\_LOWBAL, VISA\_LOWBAL)
channel: an enum: EMAIL, SMS, PUSH. The template is created for which channel
default: true/false, if this a default template
ID: a template can be queried by templateId
locale: A string, the language of the template
state: a string, a templateState. (State of a template - e.g. DRAFT, ARCHIVED, PUBLISHED - applicable for the institution based templates)
Create the default/institution template
Create an alert template POST /digitalbanking/db-alerts-management/v1/alert-templates

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Content-Type: application/JSON

Body:

alertTypeResourceId: a long, alert type ID. This is a required field.
alertTypeName: a string, an alert type name. This is a required field.
InstitutionId: unique identifier for the FI
locale: a string, language of the template
templateContents: This is an array which contains channelType, templateContentType and templateContent.
channelType: An enum: EMAIL, SMS, PUSH. The template is created for which channel. This is a required field.
templateContentType: An enum of different content types PRISM supports viz. (EMAIL\_SUBJECT, EMAIL\_BODY, SMS\_BODY, PUSH\_BODY). This is a required field.
templateContent: A string, template content. This is a required field.

Sample Body:

{
"alertTypeResourceId": 25,
"alertTypeName": "HIGHBAL",
"institutionId": "00518",
"locale": "en\_US",
"templateContents" : [
   {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_SUBJECT",
       "templateContent" : "Test Subject for email",
    },
    {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_BODY",
       "templateContent" : "Test body for email", 
    }  
]      
}

Modify/Update the institution/default template
Update an alert template PUT /digitalbanking/db-alerts-management/v1/alert-templates

Request

Query Parameters:

default: True/False. If the template is default or not.

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Content-Type: application/JSON

Body:

alertTypeResourceId: a long, Alert type ID. This is a required field.
alertTypeName: a string, an alert type name. This is a required field.
InstitutionId: unique identifier for the FI
vendor: A string, vendor name
state: state of a template (e.g. DRAFT, ARCHIVED, PUBLISHED) applicable for the institution based templates. This is a required field.
templateContents: This is an array which contains channelType, templateContentType, and templateContent.
channelType: An enum: EMAIL, SMS, PUSH. The template is created for which channel. This is a required field.
templateContentType: An enum of different content types supported viz (EMAIL\_SUBJECT, EMAIL\_BODY, SMS\_BODY, PUSH\_BODY). This is a required field.
templateContent: A string, template Content. This is a required field.

Sample Body:

{
"alertTypeResourceId": 25,
"alertTypeName": "HIGHBAL",
"institutionId": "000518",
"vendor": "CANDESCENT",
"state": "DRAFT",
"templateContents" : [
   {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_SUBJECT",
       "templateContent" : "Test Subject for email subject updated",
       "alertTemplateResourceId": 9503
   },
  {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_BODY",
       "templateContent" : "Test body for email body updated",
       "alertTemplateResourceId": 9504
   }  
]  
}

Delete institution/default Template By template ID
Delete Alert template DELETE /digitalbanking/db-alerts-management/v1/alert-templates/{id}

Request

Path Parameter:

ID: AN alert template ID that was created

Query Parameters:

default: True/False; if the template is default or not

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI

Body:

No body
Get the list of existing alert preferences
Get all the preferences opted by the user GET /digitalbanking/db-alerts-management/v1/alert-preferences

Request:

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI

Query Parameters:

alertTypes: alert type name that is unique in the system (e.g. - ATM\_WITHDRAWAL, LOWBAL, VISA\_LOWBAL, HIGHBAL)
Get the existing alert preferences by alertPreferenceId
Get alert preference by ID GET /digitalbanking/db-alerts-management/v1/alert-preferences/{alertPreferenceId}

Request

Path Parameters:

alertPreferenceId: unique alert preference ID

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Create the alert preference
Create an alert preference of a user : POST /digitalbanking/db-alerts-management/v1/alert-preferences

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Content-Type: application/JSON
InstitutionConsumerId : an institution user ID value

Body:

InstitutionId: unique identifier for the FI
InstitutionConsumerId: a string, InstitutionConsumerId. This is a required field.
alertTypeName: This is an array which contains channelType, templateContentType, and templateContent.
channelTypeName: An enum: EMAIL, SMS, PUSH. The template is created for which channel. This is a required field.
externalId: a string, placeholder for storing the alert preference / subscription external identifier of the integrating system
cardNumber: a string, card number of user
accountExternalId: a string, external system value related to account (e.g. document ID in VISA)
accountId: A string, account ID of user
alertOpted: True/False. Holds alert opt in/opt out
additionInfo: This is a Map<String, Object>, holds metadata information of an alert preference.

Sample Body:

{ 
"alertPreferenceDetails":{ 
  "institutionId":"00019",
  "institutionCustomerId":"e586dda500bb4a5eb462d6e2a8953547",
  "alertTypeName":"LOWBAL",
  "channelTypeName":"EMAIL,SMS,PUSH",
  "externalId":"extern001"
},
"alertPreferenceAccountDetails":{ 
  "cardNumber":"xxxx-xxxx-xxxx-2392",
  "accountExternalId":"accountExtern001",
  "accountId":"17011701170117011701170117011701"
},
"alertOpted":true,
"additionalInfo":{ 
}
}

Modify/Update the existing alert preference
Update an alert preference PUT /digitalbanking/db-alerts-management/v1/alert-preferences/{alertPreferenceId}

Request

Path Parameters:

alertPreferenceId: an integer, alert preference ID returned in response when creating the alert preference

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
Content-Type: application/JSON
InstitutionConsumerId : an institution user ID value

Body:

alertPrefId: unique alert preference ID
InstitutionId: Unique identifier for the FI
InstitutionConsumerId: a string, InstitutionConsumerId. This is a required field.
alertTypeName: This is an array which contains channelType, templateContentType, and templateContent.
channelTypeName: An enum: EMAIL, SMS, PUSH. The template is created for which channel. This is a required field.
externalId: a string, placeholder for storing the alert preference / subscription external identifier of the integrating system
cardNumber: a string, card number of user
accountExternalId: a string, external system value related to account (e.g. document ID in VISA)
accountId: A string, account id of user
alertOpted: True/False. Holds alert opt in/opt out
additionInfo: This is a Map<String, Object>, holds metadata information of an alert preference.

Sample Body:

{
"alertPreferenceDetails": {
   "alertPrefId": 1,
   "institutionId": "00019",
   "institutionCustomerId": "e586dda500bb4a5eb462d6e2a8953547",
   "alertTypeName": "LOWBAL",
   "channelTypeName": "EMAIL",
   "externalId":"extern001"
},
"alertPreferenceAccountDetails": {
   "cardNumber": "xxxx-xxxx-xxxx-2392",
   "accountExternalId": "accountExtern001",
   "accountId": "17011701170117011701170117011702",
},
"alertOpted": true,
"additionalInfo": {"THRESHOLD":"1000"},
"defaultPreferences": false
}

Delete alert preference added by user by alertPreferenceId
Delete Alert preference DELETE /digitalbanking/db-alerts-management/v1/alert-preferences/{alertPreferenceId}

Request

Path Parameter:

alertPreferenceId: unique preference ID to be deleted

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
InstitutionConsumerId : an institution user ID value

Body:

No body
Publish events for alerts created
Publish events POST /digitalbanking/db-events/v1/realtime-events

Request:

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
Content-Type: application/JSON

Body:

eventDomainType: an enum, type of the event Account|Transaction|Notification. This is a required field
eventDetails: This is a collection of all event details.
- eventId: a string, unique value that identifies a particular event
- eventSource: a string, source of event (e.g. CARD, etc.)
- eventOccurred: date, date/time when the actual event occurred
- eventNoticed: date, date/time when the event was notified to the system
- eventType: a string, type of event
- metaData: Map<String, Object>, additional information for the event
- eventTags: a list of tags on event to slice/dice data
- institutionId: unique identifier for the FI
- institutionUserId: a string, institution user identifier
notification: a collection of all notifications
- accountId: a string, fully-qualified account number
- identifierType: an enum, AccountId, ExternalId, or InstitutionUserId
destinationDetails: a collection of channel destinations
- contactEmail: a list of email ids of user/s
- contactNumber: a list of mobile number/s of the user/s
- contactChannels: a list of channel names which the alerts are to be sent (e.g. EMAIL, SMS)

Sample Body:

{
"eventDomainType": "notification",
"eventDetails": {
  "eventId": "ef7cff2a-989b-11e9-99a8-005056a0792f",
  "eventType": "TEST-ATMCARD\_PIN\_CHANGE",
  "eventSource": "TEST",
  "additionalInfo": {
  "CARDNUM":"1234",
  "DATE":"12/05/2019"
  },
  "institutionId": "00516",
  "memberNumber":"cmausr"
},
"notification": {
  "accountId": "xxxx-xxxx-xxxx-2392"
},
"destintionDetails":{
"contactChannels": ["EMAIL","SMS"],
"contactEmail":  ["xxxxxx@[candescent.com](http://candescent.com)"],
"contactNumber" : ["1098976655"]
}
}

Get the alert history by various parameters
Getting alert history GET /digitalbanking/db-alerts-delivery/v1/alert-history

Request

Query Parameters:

accountIds: an array of account IDs
emailStatus: an enum of email statuses (e.g. SUCCESS, FAILURE, IN\_PROCESS)
eventIds: an array of event IDs
id: search by ID
pushStatus: an enum of statuses (SUCCESS, FAILURE, IN\_PROCESS)
smsStatus: an enum of statuses (SUCCESS, FAILURE, IN\_PROCESS)
readFlag: booleam, if the published event is read or not
startDate: date, date/time start of event
endDate: date, date/time end of event

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request
InstitutionId: unique identifier for the FI
InstitutionUserId: unique user ID for the FI
Get the alert history by content Id/history summary ID/event ID
Getting alert history content GET /digitalbanking/db-alerts-delivery/v1/alert-history-content

Request

Headers:

Authorization: the bearer access token from the Authentication API
TransactionId: a UUID string used as unique identifier for this token request

Query Parameters:

alertHistoryId: a unique integer ID
eventId: a UUID generated when a successful event is created

Example Code

Here’s an excerpt from the Accounts service:

Get the list of existing alert types

Sample Response:

{
"alertTypes":[
{
    "alertTypeId": 1501,
    "alertTypeName": "HIGHBAL\_TEST1",
    "eventTypeDomain": "NOTIFICATION",
    "externalSystem": "VISA",
    "status": "ACTIVE",
    "description": "VISA Decline notification",
    "additionalInfo": null,
    "alertCategory": null
},
{
   "alertTypeId": 1503,
   "alertTypeName": "HIGHBAL\_TEST2",
   "eventTypeDomain": null,
   "externalSystem": "VISA",
  "status": "ACTIVE",
   "description": "VISA Decline notification",
   "additionalInfo": null,
  "alertCategory": null
},
{
   "alertTypeId": 5,
   "alertTypeName": "VISA-DECLINE\_ALL1",
   "eventTypeDomain": "NOTIFICATION",
   "externalSystem": "VISA",
   "status": "ACTIVE",
   "description": "Declined Transaction Alert",
   "additionalInfo": null,
   "alertCategory": null
},
{
   "alertTypeId": 3,
   "alertTypeName": "VISA-DECLINE\_ALL",
   "eventTypeDomain": "NOTIFICATION",
   "externalSystem": "VISA",
   "status": "ACTIVE",
   "description": "VISA Decline notification",
   "additionalInfo": null,
   "alertCategory": null
}
]
}

Creates an alert type for a financial institution

Sample Response:

{
"alertTypeId": 4002,
"alertTypeName": "HIGHBAL",
"eventTypeDomain": "ACCOUNT",
"externalSystem": "CANDESCENT",
"status": "ACTIVE",
"description": "High balance alert",
"channels" : "EMAIL,SMS",
"displayAlertTypeName " : "High Balance Alert"
}

Updates an existing alert type for a financial institution

Sample Response

{
"alertTypeId": 242,
"alertTypeName": "HIGHBAL",
"eventTypeDomain": "ACCOUNT",
"externalSystem": "CANDESCENT",
"status": "ACTIVE",
"description": "High balance alert Description update",
"displayAlertTypeName " : "High Balance Alert"
}

Deletes a specific alert type created by the user

Response

Returns 204 for successful response without content

Get the list of existing alert templates

Sample Response

{
"alertTemplateResources": [
   {
     "alertTypeResourceId": 25007,
     "alertTypeName": "HIGHBAL",
     "institutionId": "00518",
     "locale": "en\_US",
     "lastUpdatedDttm": "9/16/19 10:22 AM",
     "state": "DRAFT",
     "templateContents": [
         {
             "channelType": "EMAIL",
             "templateContent": "NEW TEST template testing updated",
             "templateContentType": "EMAIL\_BODY",
             "alertTemplateResourceId": 9504
         }
     ]
 },
 {
     "alertTypeResourceId": 25007,
     "alertTypeName": "HIGHBAL",
     "institutionId": "00518",
     "locale": "en\_US",
     "lastUpdatedDttm": "9/16/19 10:22 AM",
     "state": "DRAFT",
     "templateContents": [
         {
             "channelType": "EMAIL",
             "templateContent": "NEW TEST sadfstemplate testing updated",
             "templateContentType": "EMAIL\_SUBJECT",
             "alertTemplateResourceId": 9503
         }
     ]
 }
]
}

Create the default/institution template

Sample Response

{
"alertTypeResourceId": 25,
"alertTypeName": "HIGHBAL",
"institutionId": "000518",
"locale": "en\_US",
"state": "DRAFT",
"templateContents" : [
   {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_SUBJECT",
       "templateContent" : "Test Subject for email",
       "alertTemplateResourceId": 9503
    },
    {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_BODY",
       "templateContent" : "Test body for email", 
       "alertTemplateResourceId": 9504
    }  
]  
}

Modify/Update the institution/default template

Sample Response

{
"alertTypeResourceId": 25,
"alertTypeName": "HIGHBAL",
"institutionId": "000518",
"state": "DRAFT",
"templateContents" : [
   {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_SUBJECT",
       "templateContent" : "Test Subject for email subject updated",
       "alertTemplateResourceId": 9503
    },
   {
       "channelType": "EMAIL",
       "templateContentType" : "EMAIL\_BODY",
       "templateContent" : "Test body for email body updated",
       "alertTemplateResourceId": 9504
   }  
]  
}

Delete institution/default template By template ID

Response

Returns 204 for successful response without content

Get the list of existing alert preferences

Sample Response

{
"alertPreferences": [
   {
       "alertPreferenceDetails": {
          "alertPrefId": 1,
          "institutionId": "00019",
          "institutionCustomerId": "e586dda500bb4a5eb462d6e2a8953547",
          "alertTypeName": "LOWBAL",
          "channelTypeName": "EMAIL",
          "externalId":"extern001"
      },
       "alertPreferenceAccountDetails": {
          "cardNumber": "xxxx-xxxx-xxxx-2392",
          "accountExternalId": "accountExtern001",
          "accountId": "17011701170117011701170117011702",
       },
       "alertOpted": true,
       "additionalInfo": {"THRESHOLD":"1000"},
       "defaultPreferences": false
   },
   {
       "alertPreferenceDetails": {
          "alertPrefId": 2,
          "institutionId": "00019",
          "institutionCustomerId": "e586dda500bb4a5eb462d6e2a8953547",
          "alertTypeName": "LOWBAL",
          "channelTypeName": "SMS",
          "externalId":"extern001"
     },
          "alertPreferenceAccountDetails": {
          "cardNumber": "12345432145671234",
          "accountExternalId": "accountExtern001",
          "accountId": "17011701170117011701170117011701"
      },
      "alertOpted": true,
      "additionalInfo": {},
      "defaultPreferences": false
  }
]
}

Get the existing alert preferences by alertPreferenceId

Sample Response

{
"alertPreferenceDetails": {
   "alertPrefId": 1,
   "institutionId": "00019",
   "institutionCustomerId": "e586dda500bb4a5eb462d6e2a8953547",
   "alertTypeName": "LOWBAL",
   "channelTypeName": "EMAIL",
   "externalId":"extern001"
},
"alertPreferenceAccountDetails": {
   "cardNumber": "xxxx-xxxx-xxxx-2392",
   "accountExternalId": "accountExtern001",
   "accountId": "17011701170117011701170117011702",
},
"alertOpted": true,
"additionalInfo": {"THRESHOLD":"1000"},
"defaultPreferences": false
}

Create the alert preference

Sample Response

{ 
"alertPreferences":[ 
  { 
     "alertPreferenceDetails":{ 
        "alertPrefId":1,
        "institutionId":"00019",
        "institutionCustomerId":"e586dda500bb4a5eb462d6e2a8953547",
        "alertTypeName":"LOWBAL",
        "channelTypeName":"EMAIL",
        "externalId":"extern001"
     },
     "alertPreferenceAccountDetails":{ 
        "cardNumber":"xxxx-xxxx-xxxx-2392",
        "accountExternalId":"accountExtern001",
        "accountId":"17011701170117011701170117011702"
      {,
     "alertOpted":true,
     "additionalInfo":{ 
       },
     "defaultPreferences":false
  },
 }
]
}

Modify/Update the existing alert preference

Sample Response

{
"alertPreferenceDetails": {
   "alertPrefId": 1,
   "institutionId": "00019",
   "institutionCustomerId": "e586dda500bb4a5eb462d6e2a8953547",
   "alertTypeName": "LOWBAL",
   "channelTypeName": "EMAIL",
   "externalId":"extern001"
},
"alertPreferenceAccountDetails": {
   "cardNumber": "xxxx-xxxx-xxxx-2392",
   "accountExternalId": "accountExtern001",
   "accountId": "17011701170117011701170117011702",
},
"alertOpted": true,
"additionalInfo": {"THRESHOLD":"1000"},
"defaultPreferences": false
}

Delete alert preference added by user by alertPreferenceId

Response

Returns 204 for successful response without content

Publish events for alerts created

Response

Returns 202 for successful response with “Kafka Resource Accepted!!”

Get the alert history by various parameters

Sample Response

{
"alertHistorySummaryResources": [
   {
       "alertHistoryId": 27538106,
       "eventId": "357fdab8-381e-11ec-8d99-005056afdeee",
       "institutionId": "05526",
       "alertTypeName": "CUSTOM\_SAVEUP\_ALERT",
       "eventOccured": "2021-10-28T18:38:14.103+0000",
       "readFlag": false,
       "channelInfo": {
           "EMAIL": "SUCCESS"
       },
       "additionalInfo": {},
       "institutionCustomerId": "b33264360017b79e5102058009cfe704"
   },

]
}

Get the alert history by content ID/history summary ID/event ID

Sample Response

{
"alertHistoryId": 27538106,
"eventId": "357fdab8-381e-11ec-8d99-005056afdeee",
"emailContent": "<html>\n<head>\n\t<title></title>\n</head>\n<body>\n<p>This is our test body for the demo.</p>\n</body>\n</html>\n",
"emailSubjectContent": "This is our demo test.",
"alertHistoryContentId": 27492366
}

Use Cases

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Example Code

Sample Response

Response

Sample Response

Sample Response

Sample Response

Response

Sample Response

Sample Response

Sample Response

Sample Response

Response

Response

Sample Response

Sample Response

Sign in now!