Notifications

Create notification

Changed on

Create a notification for the current user. Most notifications are raised by the server from task and workspace events; this exists for integrations. Returns null when the user has turned off this notification category in their preferences.

post/notification

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/notification
  • Auth
    HTTP bearer

Request body

titlestring nullable
messagestring nullable

Stored as the notification's content.

typestring required
eventDataobject nullable
relatedEntityIdstring

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

relatedEntityTypestring

Stored as resourceType: task or workspace.

Response

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

idstring required
userIdstring required
titlestring nullable required
contentstring nullable required

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

typestring 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.

eventDataunknown
isReadboolean nullable required
resourceIdstring nullable required

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

resourceTypestring nullable required

task or workspace.

createdAtstring date-time required
updatedAtstring date-time required

Changes

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 2ed51b8af657Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the non-success response with the status