Common Elements
While the structure of the notification payload varies depending on the notification type, all payloads include a core set of standardized elements. These common elements are consistently present across all notification types, ensuring a uniform baseline of information in every message.
| Element/ Payload Example | Type | Description |
|---|---|---|
messageUUID
| String | Unique global identifier of the message |
notificationServiceVersion
| String | Specifies the version of the Notification Service payload that the configured endpoint is set to receive. |
siteName
| String | The site short name is a shortened or abbreviated identifier used to represent a journal, society or publisher. It is typically a concise version of the full name, used for easier reference across systems and interfaces. |
journalName
| String | The full name of the journal. |
eventDate
| dateTime | Indicates the exact date and time when the message was generated, recorded in (UTC). |
subscriptionId
| Integer | A unique identifier automatically assigned by the system to each configured subscription. This ID is used to distinguish and reference individual subscriptions within the platform. |
subscriptionName
| String | The name of the configured subscription that triggered the notification message. |
subscriptionType
| String | Specifies the system-defined label that categorizes the type of subscription. The supported subscription types include: Decision, Task Status Change, System Event and Checklist Question Change. |