Managing REST API Notifications
REST API notifications are managed on Customer's side
Introduction
The channel is not directed to the end user, but it serves as a means of sending notifications to the customer's or label partnerβs external API. The customer can then consume this information and transform it to a PUSH notification to a mobile app, an email to the end user or even to a marketing campaign.
Requirements
The required External APIβs definition can be found here.
The following need to be provided and agreed:
The credentials for authentication:
- For API Key authentication, the API Key needs to be provided to NET2GRID.
- For Bearer Token authentication, a username and password needs to be provided to NET2GRID.
The Customer's External API information:
- URL
- Authentication Endpoint path (i.e. /getAuthToken)
- Notification Receiving Endpoint path (i.e. /notification/message)
- If multiple labelpartners are setup in the Insight Platform, each labelpartner can specify their own preferences regarding the above parameters, however, these parameters must also be agreed on a platform level (as fallback to default/platform configuration is supported).
Example
An example of a notification that would be sent to the REST API:
{
"message_code": "BLM.01",
"timestamp": "2022-02-02T00:00:00Z",
"attributes": {
"email_address": "[email protected]",
"alert_status": true,
"gateway": "84DF0C0000000006",
"timezone": "Europe/Amsterdam"
}
message_code
: The type of the notification that is sent, based on which the relevant attributes will be applicable.
timestamp
: The timestamp of the notification.
attributes
: The attributes that are applicable for that specific type of notification. For more info, consider checking Supported Notifications
Updated about 1 year ago