StaffNotification Entity
StaffNotification EntityDescription
A StaffNotification represents a system-generated notification sent to a specific staff member, typically triggered by events such as appointment creation or client interaction. It is tied to a notification template and may contain dynamic parameters to personalize the content. The notification can be tracked through various delivery and engagement statuses.
Entity Properties
| Name | Description | Type | Required |
|---|---|---|---|
staff_uid | The unique identifier of the staff member associated with this StaffNotification. | string | Yes |
notification_template_code_name | The code name identifying the notification template to be used. | string | Yes |
locale | The language locale for the notification content. Defaults to "en" if not specified. | string<br>(enum: en, fr, de, it, pl, pt, es, nl, he, sl, en_gb) | No |
params | Additional parameters for populating notification templates. Each param is a key-value pair. | array of { key: string, value: string } | No |
status | The current statuses of the staff notification. Used in updates only. | array of string<br>(enum: processed, dropped, deferred, bounce, delivered, open, click, spam_report, unsubscribe) | Yes (for updates) |
Example
{
"staff_uid": "staff-67890",
"notification_template_code_name": "new_appointment_created",
"locale": "en",
"params": [
{
"key": "client_name",
"value": "John Doe"
},
{
"key": "appointment_time",
"value": "2023-05-15T14:30:00Z"
}
]
}