Events Notifications
Overview
Each notification generated through the Events API has an associated Topic ID and Template ID. The Topic uniquely identifies the purpose of the notification (i.e. what event it represents) whereas the Template identifies the format of the information presented within the notification (i.e. what data properties will be included).
Primary Templates
TID-002 (generic notification)
{ |
TID-010 (entity-specific notification)
{ |
TID-013 (accounting document notification)
{ |
TID-014 (operational/functional notification)
{ |
TID-018 (workflow/process request)
{ |
AdditionalParameters
When information specific to the Topic needs to be included, the AdditionalParameters section is used.
The list below identifies Topics that contain AdditionalParameters.
Topic 2-13 / 6-3 (redirected to 3-10)
| 1 | Key | freezedate |
| Value | yyyymmdd OR yyyymm32 for month freeze |
Topic 2-266 (redirected to 3-10)
| 1 | Key | docname |
| Value | name of the document | |
| 2 | Key | doctype |
| Value | type of document ('WI') | |
| 3 | Key | docdescription |
| Value | description of type of document ('Warehouse Instruction') | |
| 4 | Key | contractlist |
| Value | contract collection |
Topic 6-20 (redirected to 3-10)
| 1 | Key | submittedby |
| Value | username |
Topic 6-21
| 1 | Key | docname |
| Value | name of the document | |
| 2 | Key | doctype |
| Value | document classification | |
| 3 | Key | docindexid |
| Value | document ID as required when using GET /Documents/{id} (for index details) and GET /Documents{id}/download (for retrieving the document) | |
| 4 | Key | action |
| Value | Added ¦ Updated ¦ Deleted | |
| 5 | Key | actionstatus |
| Value | OK ¦ Aborted ¦ Failed | |
| 6 | Key | actionresponse |
| Value | message presented to user |
Topic 3-300
| 1 | Key | DATE |
| Value | yyyymmdd OR yyyymm32 for month freeze | |
| 2 | Key | KEEPDAYS |
| Value | n = number of days to keep | |
| 3 | Key | KEEPFRIDAYS |
| Value | n = number of friday freezes to keep |
NOTE: Notifications available through Topic 6-21 for processes that use Document Services API