Notifications
Added in: release-2021-03​
You can configure notifications to enable the possibility that a user can get notifications for changes on a document.
1
module.exports = {
2
v: 2,
3
notifications: {
4
// Define actionGroups which the user can select per document
5
actionGroups: [
6
// First example group, interested in ALL changes
7
{
8
handle: 'all',
9
label: 'All Events',
10
description: 'Comments, Tasks, Publish and delete',
11
// add actions on which the user should get a notification
12
actions: [
13
'task.change',
14
'document.publish',
15
'document.unpublish',
16
'document.copy',
17
'document.delete',
18
'document.transform',
19
'comment.add'
20
]
21
}
22
],
23
// the task requester is notified on task changed even without subscription
24
notifyTaskRequester: true,
25
// the author is auto subscribed to the document with the specified actionGroup
26
autoSubscribeOwner: {enabled: true, actionGroup: 'all'}
27
}
28
}
Copied!
Possible action to register on at the moment:
  • task.change config options:
    1
    // assign to all tasks and statusChanges
    2
    'task.change'
    3
    ​
    4
    // assign to task proofreading on statusChanges 'requested', 'accepted', 'completed'
    5
    {type: 'task.change', taskName: 'proofreading', statusChange: ['requested', 'accepted', 'completed']}
    Copied!
  • document.publish
  • document.unpublish
  • document.copy
  • document.delete
  • document.transform
  • comment.add
Last modified 8mo ago
Copy link