Skip to main content
There are three ways to send notifications to your users:

In-app notifications

Add notifications component within your app.

Email notifications

Send email notifications to your users.

Webhooks

Send notifications to other channels like Slack.

In-app notifications

Add notifications component within your app. Learn more about In-app notifications.

Email notifications

You can enable email notifications to send out emails whenever you @mention a user in the Comments feature or when another user replies to your comment. There are two ways to trigger email notifications: Webhooks and SendGrid.

Webhooks for non-SendGrid services

To learn how to trigger email notifications via Webhooks please refer here.

SendGrid Integration

To enable Email Notifications, go to the Configurations -> Email Service in the Velt Console, or click here. For SendGrid integration, provide the following details:
  • SendGrid API Key
  • SendGrid Email Template ID for Comments feature
  • ‘From’ Email Address
The ‘From’ Email Address needs to be whitelisted from your SendGrid account or else it will not work.

Email Template Data

The following fields are sent to Sendgrid:
FieldTypeDescription
firstCommentCommentFirst message in the thread. Only Contains commentId, commentText and from properties derived from Comment class.
latestCommentCommentLatest message in the thread that prompted the email. Only Contains commentId, commentText and from properties derived from Comment class.
prevCommentCommentPrevious message to the latestMessage. Only Contains commentId, commentText and from properties derived from Comment class.
commentsCountstringTotal number of comments in the comment annotation
commentsCountMoreThanThreestringTotal number of remaining comments in the comment annotation beyond the three that this payload contains
fromUserUserAction user’s object
commentAnnotationCommentAnnotationThe comment annotation object without the comments field
actionTypestringThe action that resulted in the notification. You can find the list of action types here
documentMetadataDocumentMetadataThe document metadata object
These are the older fields that will be deprecated soon. These are already contained in the fields above:
FieldTypeDescription
messagestringthe message of the email
messageFromNamestringthe name of whoever wrote the message that the email is referencing. If name is not found then it will contain the email.
namestringthe name of the person who performed the action that triggered the email. If name is not found then it will contain the email. Sometimes a notification can be triggered without a message. For those cases, you can use this.
fromEmailstringemail address of the user who performed the action
photoUrlstringavatar URL of user
pageUrlstringurl of the page the comment is on
pageTitlestringtitle of the web page
deviceInfoObjectcontains browser, OS and device info
subjectstringsubject of the email

Sample Payload sent to SendGrid

Download Sample Email Template

We have provided this sample HTML email template you can use for your SendGrid email template: Download Link

Webhooks

Send notifications to other channels like Slack. Learn more about Webhooks.