GuidesAPI ReferenceDiscussions
API Reference

Create Add-on notifications

post
https://api.servicem8.com/api_1.0/notification.json

Sends an in-app and push notification from the calling Add-on to each unique Staff recipient. All recipients are validated before any notifications are created. ServiceM8 supplies the sender, notification type, timestamp, and icon; Add-ons cannot override these fields.

Each successful request creates new notifications. Retrying a successful request may create duplicates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
recipient_staff_uuids
array of uuids
required
length ≥ 1

Active Staff UUIDs from the current account. Duplicate UUIDs are ignored. If any recipient is invalid, no notifications are created.

recipient_staff_uuids*
string
required

Non-blank notification message. Supports the limited HTML subset <b>, <i>, and <br>. Other HTML tags are removed while preserving their text.

string

Optional plaintext notification title. HTML tags are removed.

string

Optional destination opened when the recipient selects the notification. Supported routes are servicem8://job/{job_uuid}, servicem8://job/{job_uuid}/diary, and servicem8://inbox/{inbox_message_uuid}. The referenced object must exist in the current account.

integer
0 to 100
Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?