Webhooks
Basic Webhooks
Set up a webhook endpoint to receive real-time notifications for the following Velt events:
Setting up a Webhook
To enable Webhooks go to the Configurations -> Webhook Service in the Velt Console, or click here
Webhook Auth Token
- Optional security feature to authenticate webhook requests.
- Set a unique auth token in your Velt console’s webhook settings.
- We add this token to the Authorization header of each request as
Basic YOUR_AUTH_TOKEN
. - Helps you verify that requests are from Velt, not from unauthorized sources.
Endpoint URL
- This is the endpoint that we will send the webhook data to. This is usually hosted on your server.
Payload Encoding
-
Enable Base64 encoding for webhook payloads (disabled by default).
-
Addresses issues with payloads containing HTML tags that may fail due to strict endpoint policies.
-
If enabled, ensure your server can decode Base64 encoded payloads.
-
Example of decoding a Base64 encoded payload:
Payload Encryption
- Enable payload encryption for enhanced security (disabled by default).
- Configure this option in the Velt Console.
- Encryption details:
- Payload encryption: AES-256-CBC
- Key encryption: RSA with PKCS1 OAEP padding and SHA-256 hash
- Public key format:
- Provide only the base64-encoded key string, without PEM headers/footers
- Recommended key size: 2048 bits
- Example of setting up decryption for Node.js:
Comments Events
The Comments
component will emit webhook notifications whenever an action type
occurs on a comment.
List of Action Types
Action Type | Description |
---|---|
newlyAdded | When the first comment in a thread is added |
added | When a new comment is added. Not used for the first comment in a thread - see newlyAdded |
updated | When an existing comment content gets updated |
deleted | When an existing comments gets deleted |
approved | When the comment is approved by the moderator. This is only applicable if you have turned on Moderator Mode. |
assigned | When a comment gets assigned to a user |
statusChanged | When a comment has its status changed (e.g. in progress, resolved, opened) |
priorityChanged | When a comment has its priority changed (e.g. P0, P1, P2 or custom set priorities) |
accessModeChanged | When a comment is changed from private to public or vice-versa |
accepted | When a comment gets accepted by the moderator. This is only applicable if you have turned on Moderator Mode. |
rejected | When a comment gets rejected by the moderator. This is only applicable if you have turned on Moderator Mode. |
reactionAdded | When a reaction is added to a comment. |
reactionDeleted | When a reaction is removed from a comment. |
subscribed | When a user subscribes to a comment annotation using the option in the UI. |
unsubscribed | When a user unsubscribes from a comment annotation using the option in the UI. |
Webhook Data
Field | Type | Required | Description |
---|---|---|---|
webhookId | string | Yes | The unique identifier for the webhook event. |
commentAnnotation | CommentAnnotation | Yes | The target CommentAnnotation object on which the event happened. |
targetComment | Comment | Optional | The target Comment object on which the event happened. This field will not be present if the event was at CommentAnnotation level. Eg: deleted the entire comment annotation, resolved comment, approved comment. |
actionType | string | Yes | This can have the values listed above |
notificationSource | string | Yes | Indicates the source of the notification |
actionUser | string | Yes | Contains information about the user who performed the action, including their name, email, and user ID. |
metadata | string | Yes | This field contains additional metadata related to the annotation, such as the API key, client document ID, document ID, and information about various locations where the annotation is associated with a web page. |
Sample Webhook Data
Huddle Events
The Huddle
component will emit webhook notifications when a user creates or joins a group huddle.
List of Action Types
Action Type | Description |
---|---|
created | When a User created a Huddle |
join | When a User joins a Huddle |
Webhook Data
Field | Type | Required | Description |
---|---|---|---|
webhookId | string | Yes | The unique identifier for the webhook event. |
actionType | string | Yes | Type of action: created or joined |
notificationSource | string | Yes | Source of notification: huddle |
actionUser | UserObject | Yes | The user who performed the action |
metadata | object | Yes | Metadata related to the action |
Sample Webhook Data (Huddle Created)
Sample Webhook Data (Huddle Joined)