Skip to main content
POST
Create notification

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Body

application/json
type
string
required
title
string | null
message
string | null

Stored as the notification's content.

eventData
object | null

Stored as resourceId: the task or workspace being pointed at.

Stored as resourceType: task or workspace.

Response

The created notification, or null when the user has muted this notification type

id
string
required
userId
string
required
title
string | null
required
content
string | null
required

Free-text body. Null for generated notifications, whose text the client renders from type and eventData.

type
string
required

One of: info, task_created, workspace_created, task_status_changed, task_assignee_changed, time_entry_created, due_date_reminder, task_overdue, task_mention, task_comment.

isRead
boolean | null
required
resourceId
string | null
required

The id of the task or workspace the notification points at.

resourceType
string | null
required

task or workspace.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
eventData
any

Type-specific payload, e.g. { taskTitle, oldStatus, newStatus, projectId, workspaceId }.