Last Updated: July 27, 2018
Following is a list of the properties that belong to a notification, and a description of each.
- Integer. Read-only. Id of notification.
- Integer. User id for the user that this notification will be sent to.
- String. Read-only. A GUID string used for additional tracking.
- String. The message text of the notification. The maximum message length is 2000 characters.
- String. The transport method of the notification. We support 'push', 'email', and 'dashboard'.
The 'push' method utilizes the TSheets mobile app to deliver the notification to a mobile device.
The 'email' method sends an Email to the user (if they have an Email address).
The 'dashboard' method utilizes the TSheets web dashboard notification queue to deliver a notification to the user. They will only see this when they're logged in to the TSheets web app.
- String. The precheck macro name. Supported macros are 'on_the_clock', 'off_the_clock', and 'none'. The 'on_the_clock' macro will first check if the recipient is on the clock before sending and if not, will discard the notification. The 'off_the_clock' macro will first check if the recipient is off the clock (and not on PTO) before sending and if not, will discard the notification. The 'none' macro (the default) will not perform any checks before sending.
- String (ISO8601 format). Date/time when this notification will be delivered (i.e. 2015-06-12T15:19:21+00:00). Defaults to the current time.
- String (ISO8601 format). Date/time when this notification was created (i.e. 2015-06-12T15:19:21+00:00).