Skip to main content
POST
/
notification
Create Notification
curl --request POST \
  --url https://cloud.kaneo.app/api/notification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "title": "<string>",
  "message": "<string>",
  "eventData": {},
  "relatedEntityId": "<string>",
  "relatedEntityType": "<string>"
}
'
{
  "id": "<string>",
  "userId": "<string>",
  "title": "<string>",
  "content": "<string>",
  "type": "info",
  "eventData": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "isRead": true,
  "resourceId": "<string>",
  "resourceType": "task"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Body

application/json
​
type
string
required
​
title
string | null
​
message
string | null
​
eventData
object
​
relatedEntityId
string
​
relatedEntityType
string

Response

200 - application/json

Notification created successfully

​
id
string
required
​
userId
string
required
​
title
string | null
required
​
content
string | null
required
​
type
enum<string>
required
Available options:
info,
task_created,
workspace_created,
task_status_changed,
task_assignee_changed,
time_entry_created,
due_date_reminder,
task_overdue
​
eventData
object
required
​
createdAt
string<date-time>
required
​
isRead
boolean
​
resourceId
string
​
resourceType
enum<string>
Available options:
task,
workspace