Sign in
Notifications

Trigger inbox notification

Changed on

This endpoint triggers an inbox notification. Corresponds to liveblocks.triggerInboxNotification.

post/inbox-notifications/trigger

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/inbox-notifications/trigger
  • Auth: none declared

Request body

userIdstring required
kindstring required

A custom notification kind. Must start with '$' and contain only letters and underscores (max 128 characters).

subjectIdstring required
roomIdstring
activityDataobject required
organizationIdstring

Example request

{
  "userId": "alice",
  "kind": "$fileUploaded",
  "subjectId": "file123",
  "activityData": {
    "url": "url-to-file"
  }
}

Response

No Content

Changes

  • 22a5e987b8c9Revision changes
    • breaking

      request body became required

    • breaking

      added the pattern ^\$[a-zA-Z_]{1,128}$ to the request property

  • 77cd6a75b2b7Revision changes
    • info

      api operation id post-inbox-notifications-trigger removed and replaced with trigger-inbox-notification

    • info

      added the new optional request property