Properties
| Property | Type | Description |
|---|---|---|
| enabled | Boolean | Whether notification is enabled . |
| events | String | Comma-separated list of event types that trigger this notification . |
| from | String | Sender email address . |
| id | String | Notification ID . |
| message | String | Email message body template . |
| name | String | Name . |
| onError | Boolean | Trigger on error events . |
| onSuccess | Boolean | Trigger on success events . |
| pathFilter | String | Path filter pattern . |
| pathFilterInverse | Boolean | Whether to invert path filter (true = exclude matching paths) . |
| rowOrder | Number | Display order . |
| schedule | String | Schedule expression for timed notifications . |
| siteFilterInverse | Boolean | Whether to invert site filter (true = exclude matching sites) . |
| sites | String | Comma-separated list of site IDs to filter on . |
| subject | String | Email subject template . |
| to | String | Recipient email address . |
| userFilterInverse | Boolean | Whether to invert user filter (true = exclude matching users) . |
| users | String | Comma-separated list of user IDs to filter on . |
Property Details
enabled :Boolean
- Description:
Whether notification is enabled
Whether notification is enabled
Type:
- Boolean
events :String
- Description:
Comma-separated list of event types that trigger this notification
Comma-separated list of event types that trigger this notification
Type:
- String
from :String
- Description:
Sender email address
Sender email address
Type:
- String
id :String
- Description:
Notification ID
Notification ID
Type:
- String
message :String
- Description:
Email message body template
Email message body template
Type:
- String
name :String
- Description:
Name
Name
Type:
- String
onError :Boolean
- Description:
Trigger on error events
Trigger on error events
Type:
- Boolean
onSuccess :Boolean
- Description:
Trigger on success events
Trigger on success events
Type:
- Boolean
pathFilter :String
- Description:
Path filter pattern
Path filter pattern
Type:
- String
pathFilterInverse :Boolean
- Description:
Whether to invert path filter (true = exclude matching paths)
Whether to invert path filter (true = exclude matching paths)
Type:
- Boolean
rowOrder :Number
- Description:
Display order
Display order
Type:
- Number
schedule :String
- Description:
Schedule expression for timed notifications
Schedule expression for timed notifications
Type:
- String
siteFilterInverse :Boolean
- Description:
Whether to invert site filter (true = exclude matching sites)
Whether to invert site filter (true = exclude matching sites)
Type:
- Boolean
sites :String
- Description:
Comma-separated list of site IDs to filter on
Comma-separated list of site IDs to filter on
Type:
- String
subject :String
- Description:
Email subject template
Email subject template
Type:
- String
to :String
- Description:
Recipient email address
Recipient email address
Type:
- String
userFilterInverse :Boolean
- Description:
Whether to invert user filter (true = exclude matching users)
Whether to invert user filter (true = exclude matching users)
Type:
- Boolean
users :String
- Description:
Comma-separated list of user IDs to filter on
Comma-separated list of user IDs to filter on
Type:
- String