📜 GetNotificationHistory and onGetNotificationsHistory
🔍 Overview
The getNotificationHistory API fetches historical notifications acted upon by the user. It supports filters like date range, keyword, status, and action performed.
The response is received asynchronously via the onGetNotificationsHistory event.
🔗 Method Signature
Parameters
Parameter
Type
Description
recordCount
Number
Number of records to fetch (0 = all)
enterpriseID
String
Optional, can be empty if not used
startIndex
Number
Should be ≥ 1
startDate
String
Format: yyyy-MM-dd'T'HH:mm:ssz, optional
endDate
String
Format: yyyy-MM-dd'T'HH:mm:ssz, optional
notificationStatus
String
Filter by status (e.g., EXPIRED, UPDATED)
actionPerformed
String
Filter by action taken (Accept, Reject, etc.)
keywordSearch
String
Search string across notifications
deviceID
String
Filter by specific device ID
🎯 Event: onGetNotificationsHistory
This event is triggered after calling getNotificationHistory. Notifications are provided in:response.pArgs.response.ResponseData.history.
📋 Fields in onGetNotificationsHistory Payload
Field
Type
Description
notification_uuid
String
Unique identifier for the notification
status
String
Final status of the notification: EXPIRED, UPDATED, TAMPERED, etc.
signing_status
String
Signature validation status: Verified, Failed, NA
action_performed
String
Action taken by user, e.g., Accept, Reject, Fraud
update_ts
String
Timestamp of user action or system update (ISO format)
create_ts
String
Time the notification was generated (ISO format)
expiry_timestamp
String
Expiry time of the notification (ISO format)
body
Array
Localized content (subject/message pairs), each with:
→ lng
String
Language code of the message content (e.g., "English")
→ subject
String
Notification title shown to the user
→ message
String
Notification body message
actions
Array
List of possible actions (rare in history; mostly used in active notif)
→ label
String
Text to show on the button (e.g., "Accept")
→ action
String
Action value (e.g., accept, reject)
→ authlevel
String
Authentication level needed (usually "0" for most)
ds_required
Boolean
Whether digital signature was required
🔖 Notification Status Values
Status
Meaning
EXPIRED
Notification was not acted upon within the configured expiry window
UPDATED
Notification has been updated after user interaction
TAMPERED
Notification data was found altered during validation
DISMISSED
Notification was dismissed or cleared by the user or system
NEW
Fresh notification at time of generation (used internally, not in history)
🛡️ Digital Signing Status (signing_status)
Status
Meaning
Verified
Signature associated with the notification was validated successfully
Failed
Signature validation failed (possible tampering or integrity loss)
NA
Not applicable (e.g., non-signing notifications or legacy messages)