Add Notifications

curl --request POST \
  --url https://api.velt.dev/v2/notifications/add \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <api-key>' \
  --header 'x-velt-auth-token: <api-key>' \
  --data '{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "actionUser": {
      "userId": "yourUserId",
      "name": "User Name",
      "email": "user@email.com"
    },
    "verifyUserPermissions": false,
    "notificationId": "<string>",
    "displayHeadlineMessageTemplate": "<string>",
    "displayHeadlineMessageTemplateData": {},
    "displayBodyMessage": "<string>",
    "notifyUsers": [
      {
        "userId": "yourUserId",
        "name": "User Name",
        "email": "user@email.com"
      }
    ],
    "notifyAll": true,
    "notificationSourceData": {}
  }
}'

{
  "result": {
    "status": "success",
    "message": "Operation completed successfully",
    "data": {}
  }
}

Notifications

Add Notifications

Use this API to add notifications.

Key Points:

Send custom notifications to users via inbox, email, and other channels
Support for template variables in headline messages
Can notify specific users or all users in organization

Optional Parameters:

verifyUserPermissions: When enabled, notifications are only created for users who have access to the specified document (default: false)
notificationId: Custom notification ID to prevent duplicate notifications. Only special characters _, - are allowed
notifyAll: If set to true, notification will be sent to all users in the organization (default: true)
notificationSourceData: Any custom object to be stored with the notification. When the user clicks on the notification, this data will be sent in the callback

📚 Full Documentation: https://docs.velt.dev/api-reference/rest-apis/v2/notifications/add-notifications

POST

notifications

add

Add Notifications

curl --request POST \
  --url https://api.velt.dev/v2/notifications/add \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <api-key>' \
  --header 'x-velt-auth-token: <api-key>' \
  --data '{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "actionUser": {
      "userId": "yourUserId",
      "name": "User Name",
      "email": "user@email.com"
    },
    "verifyUserPermissions": false,
    "notificationId": "<string>",
    "displayHeadlineMessageTemplate": "<string>",
    "displayHeadlineMessageTemplateData": {},
    "displayBodyMessage": "<string>",
    "notifyUsers": [
      {
        "userId": "yourUserId",
        "name": "User Name",
        "email": "user@email.com"
      }
    ],
    "notifyAll": true,
    "notificationSourceData": {}
  }
}'

{
  "result": {
    "status": "success",
    "message": "Operation completed successfully",
    "data": {}
  }
}

Authorizations

x-velt-api-key

string

header

required

Your API key from the Velt Console

x-velt-auth-token

string

header

required

Your Auth Token for authentication

Body

application/json

data

object

required

Show child attributes

Response

Notifications added successfully

result

object

Show child attributes

Remove Permissions Get Notifications

⌘I

REST APIs

SDK

Add Notifications

Authorizations

Body

Response