Liveblocks icon

Liveblocks

Call the Liveblocks REST API (rooms, comments, feeds, Yjs, AI, and more)

Inbox → Trigger Notification

AI-generated

Summary

Send a custom inbox notification to a specific user within the Liveblocks platform.

Inputs

  • User ID (required) — The identifier of the user to receive the notification.
  • Kind (required) — The notification type, where custom kinds must start with $ and contain only letters and underscores (up to 128 characters).
  • Subject ID (required) — An identifier related to the subject of the notification.
  • Room ID — The room identifier associated with the notification, if applicable.
  • Activity Data (required) — A JSON object containing additional data related to the notification activity.
  • Organization ID — The organization identifier relevant to the notification context.
  • Include Request in Error — Optional flag to include full request details in error messages for debugging.

Output shape

a JSON object representing the result of triggering the inbox notification

The response includes server confirmation of the notification trigger; errors will reflect API call failures, optionally enriched with request details when enabled.

Links

Discussion