Modules

Calendar

Certificates

CollectiveAgreements

Company Forms

Company Forms Management

Contacts

Contracts

Customer Assets

Equipment

Expenses

Job Invoices

Jobs

Labour Actions

Library

Locates

Materials

Messages

Purchase Orders

Safety

Schedule

Service Quotes/Invoices

Service Requests

Services

Settings

TimeLogs

Users

Other

Notification Resource


Pushes a notification to the Alert Center, as well as optionally (by default) a push notification to the user's device

Endpoints

Endpoints URI Access Control Description
list-events GET /api/Notification/list-events Endpoint level permissions
save POST /api/Notification/save Admin or Module WRITE In addition to saving to the notifications, it also sends a push notification, unless the suppress_push parameter is set to true
dismiss GET /api/Notification/dismiss Authentication only
dismiss-all GET /api/Notification/dismiss-all Authentication only
get GET /api/Notification/get Authentication only
find GET /api/Notification/find Admin or Module READ
delete POST /api/Notification/delete Admin or Module WRITE
compileCachedRelations GET /api/Notification/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
user_id number
module string

List of valid modules:

  • Jobs
  • Services
  • ServiceContracts
  • Certificates
  • Equipment
  • Users
  • Library
  • TimeLogs
  • Notification
  • Locates
  • CompensationSchedule
  • CompanyForms
  • ServiceRequest
  • Calendar
event string

List of valid notification events:

Event Value Description
Jobs:role:added Added as a role on a project
Jobs:purchaseOrder:finalized Purchase Order finalized
Jobs:purchaseOrder:definalized Purchase Order de-finalized
Jobs:completed Project marked as complete
Jobs:noteCreated Note created on a project you have a role on
Jobs:changeQuote:created Project Change Order Quote created
Services:role:added Added as role on a service
Services:technician:assigned Assigned as a technician on a service
Services:appointment:changed Service appointment changed
Services:appointment:set Service appointment set
Services:invoice:finalized Service invoice finalized
Services:invoice:definalized Service invoice de-finalized
Services:invoice:paid Service invoice paid
Services:invoice:overdue Service invoice overdue
Services:invoice:received Service invoice received
Services:quote:received Service quote received
Services:quote:followupDue Service quote followup date has arrived
Services:status:changed Service status changed
Services:purchaseOrder:finalized Purchase Order finalized
Services:purchaseOrder:definalized Purchase Order de-finalized
ServiceContracts:autoInvoicesSent Automatic invoices generated and sent
ServiceContracts:expiryUpcoming Service Contract expiring soon
ServiceContracts:role:added Added as a role on a service contract
Certificates:expired Training certificate expired
Certificates:expiryUpcoming Training certificate expiring soon
Certificates:user:added New user certificate added
Equipment:serviceDue Maintenance event due on equipment
Equipment:serviceUpcoming Maintenance event upcoming on equipment
Users:invite:accepted Employee invite accepted
Users:vacation:scheduled Employee scheduled vacation
Users:vacation:started Employee has begun vacation
Users:vacation:ended Employee has ended vacation
Users:vacation:approved Vacation request approved
Users:vacation:rejected Vacation request rejected
Users:sickday Employee has called in sick
Library:user:tagged You are tagged on a Library file
Library:fileUpdated A Library file you have acknowledged was updated
Library:fileExpired A Library file you have uploaded has expired
Library:acknowledgementDue A Library file you have acknowledged is due to be acknowledged again
TimeLogs:onsiteReminder Clock in onsite reminder
Notification:generic General notices
Locates:expiryUpcoming Project/Service locate expiring soon
Locates:expired Project/Service locate expired
Locates:refreshUpcoming Project/Service locate refresh due soon
Locates:refreshDue Project/Service locate refresh due
CompensationSchedule:expiryUpcoming Comp. Schedule expiring soon
CompensationSchedule:expired Comp. Schedule expired
CompanyForms:incomplete Required Company Form not completed
CompanyForms:signingInvitation An invitation to sign a company form
CompanyForms:signed A worker has signed your company form
CompanyForms:expiringIncomplete Your company form is expiring soon and still required signatures
CompanyForms:required Company form required
ServiceRequest:accepted Service Request accepted
ServiceRequest:rejected Service Request rejected
ServiceRequest:created Service Request created
Calendar:eventNotice You are assigned to an event on the schedule
Calendar:deleteRequest Your employer would like to delete one of your Calendar events
message string
module_slug string
resource string
resource_slug string
link string
new_tab boolean
meta_json string
is_urgent boolean
is_dismissed boolean
suppress_push boolean
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order created_at DESC

Relationships

Related Resource Key Relationship to Notification Property
User user_id Belongs To User