Use the 'Notifications' tab of Settings to manage your push notifications.
This is where you create, filter and manage notifications via a
- + Create notification button: this will initiate the notification creation flow.
- Search bar: typing in the search bar will filter the notifications by title.
- List of notifications: click the gear button to change a notification's settings and click the red bin button to delete it.
You can create a number of event-based or timing-based notifications to help monitor your workflow activity:
- Email: send an email when certain events happen.
- Slack: send a Slack message when certain events happen.
- Digest: send regular emails giving a summary of activity over a given time period.
- Webhook: send a JSON payload to a REST endpoint when certain events happen.
Video Tutorial - Creating webhooks in Workflow projects
To create a new notification, click the + Create notification button in the Notifications view. This initiates the notification creation flow, a simple step-by-step process for creating push notifications.
In the 'Enter details' screen, enter a notification title and optional description. A clear title and description helps keep your notifications organized and helps collaborators find what they are looking for. When you are happy, click Next.
In the 'Add projects' screen, select the projects you would like to include in this notification. When you are happy, click Next.
In the 'Add channels' screen, choose how you would like to receive the notification.
Click the Add Slack channel button to add a Slack channel.
Once redirected to the Slack web page, make sure to first select the correct workspace from the top right drop-down list. Then select the channel you would like to post Slack notifications to.
Add the channel and make sure to refresh the grid by clicking on the refresh icon above the Slack channels grid.
For a given user the available Slack channels are shared between all notifications.
Enter the email addresses of everyone who should receive the notifications in the entry box. A list of emails will appear above the box for each entered email.
Encord attempts to reduce the number of outgoing emails.
New emails are not sent immediately, instead the email notifications are aggregated and sent in 5 minute intervals.
Consequently, you may not receive emails immediately on the triggering of an event.
Add a webhook by clicking the Add webhook button. Fill in all the relevant information.
You can create, change and delete webhooks. You cannot attach or detach them; to "detach" a webhook you need to delete it. There is currently no sharing of webhooks between notifications.
Click here for a list of all possible events.
In the 'Add triggers' screen, choose what type of events will trigger a notification. A notification can have multiple triggers. You can choose from 'Reactive events' and 'Digest events':
- Reactive events: notification will be triggered in reaction to an event
- Digest events: notification will be triggered at a regular time of day
Use the info icon next to the event type to get more detailed explanations on when these events are triggered.
Once you are happy with the triggers, click Create to create the push notification.
These are example use cases for different workflows using the notifications feature.
You might want to have reviewers receive notifications whenever an annotation is finished, so reviewers can add their review without manually checking whether new annotations have been created.
For this workflow you would
- create a new notification
- add the projects you are interested in
- add all the email addresses or Slack channels where your reviewer would expect them
- finally enable the "Task submitted" trigger.
Whenever a task is submitted, a push notification will be sent to the reviewers. A relevant link will be included to direct them to the project page that they need to open.
As a manager, you might be interested in the progress of annotations and reviews in your project.
- Create a new notification.
- Select relevant projects.
- Select your own email address or preferred Slack channel.
- Enable the "Full digest" trigger.
You will now receive a summary of the last 24h daily at 5pm UTC on your projects. This summary includes every participating annotator and reviewer and their participation statistics.
You might want to kick off a script or program once a given image sequence or video has been fully annotated and approved.
In this case you would
- Create a new notification.
- Select all relevant projects.
- Add a webhook which points to the exact URL where you expect the webhook push notification to arrive.
- Enable the "Task completed" trigger.
Whenever the last label has been approved or a task has been completed without reviews being required, an HTTP message will be sent to the configured webhook endpoints. An explanation of the notification can be found below.
Every event will have the following top level fields
|Unique identifier of the event|
|Major version number to indicate backwards incompatible versions|
|Will always be the string "Encord"|
|The event type. See below for more info.|
|A string of the timestamp in the ISO 8601 format. For example |
|An object with different fields depending on the type of event. See below for more info.|
|The unique identifier for the project.|
|The unique hash identifier for the project.|
|The unique hash identifier for the label.|
|Array of ProjectStats objects|
Please note that the summary statistics are all for the time frame of the daily digest. This is currently 24h.
|Email address of the user|
|Number of labels the user has submitted|
|Number of labels that were accepted by a reviewer|
|Number of labels that were rejected by a reviewer|
|Average time it took for the annotator to add a label in milliseconds. This field is optional.|
|Average time it took for the annotator to edit a label in milliseconds. This field is optional.|
|The number of rejected labels over all rejected and approved labels.|
|Total time it took for adding and editing labels in milliseconds.|
|Email address of the user|
|Number of labels rejected|
|Number of labels accepted|
|Average time it took to process a single review|
|Total number of reviews|
|Total time spent on reviews|
|Rejected reviews over all reviews|
Updated 26 days ago