Create a new notification

Create a custom notification for workspace users

POST

https://api.channelautomation.com/api/notifications/{workspaceId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required
Workspace ID for data isolation

Request body JSON required

title
string
required
Notification title

maxLength: 255
message
string
required
Detailed notification message

maxLength: 1000
type
optional
info
or
success
or
warning
or
error
Notification type

default: "info"
priority
optional
low
or
medium
or
high
or
urgent
Priority level

default: "medium"

Returns

201

Notification created successfully

JSON

success
optional
boolean
notification
optional
object
- id
  optional
  string
  Unique notification identifier
- workspace_id
  optional
  string
  Workspace ID
- title
  optional
  string
  Notification title
- message
  optional
  string
  Notification message content
- type
  optional
  info
  or
  success
  or
  warning
  or
  error
  Notification type
- priority
  optional
  low
  or
  medium
  or
  high
  or
  urgent
  Notification priority level
- read
  optional
  boolean
  Whether notification has been read
  
  default: false
- dismissed
  optional
  boolean
  Whether notification has been dismissed
  
  default: false
- created_at
  optional
  string
  Notification creation timestamp
  
  format: date-time
- updated_at
  optional
  string
  Last update timestamp
  
  format: date-time
}
message
optional
string

400

Bad request

500

Server error

Create a new notification

curl --request POST \
  --url 'https://api.channelautomation.com/api/notifications/<workspaceId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "System Alert",
  "message": "Your SMS quota is running low",
  "type": "info",
  "priority": "low"
}
'

const url = 'https://api.channelautomation.com/api/notifications/<workspaceId>';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    title: 'System Alert',
    message: 'Your SMS quota is running low',
    type: 'info',
    priority: 'low'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/notifications/<workspaceId>"

payload = {
    "title": "System Alert",
    "message": "Your SMS quota is running low",
    "type": "info",
    "priority": "low"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "notification": {
    "id": "string",
    "workspace_id": "string",
    "title": "New Message Received",
    "message": "You have received a new message from John Doe",
    "type": "info",
    "priority": "medium",
    "read": false,
    "dismissed": false,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "message": "Notification created successfully"
}