Liveblocks icon

Liveblocks

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

User → Update Notification Settings

AI-generated

Summary

Update a Liveblocks user's notification settings for different channels and event types by specifying their preferences for email, Slack, Microsoft Teams, and web push notifications related to threads and text mentions.

Inputs

  • User ID (required) — The unique identifier of the user whose notification settings are to be updated.
  • email — Thread — Set email notifications for thread events to On or Off, or omit to leave unchanged.
  • email — Text Mention — Set email notifications for text mention events to On or Off, or omit to leave unchanged.
  • slack — Thread — Set Slack notifications for thread events to On or Off, or omit to leave unchanged.
  • slack — Text Mention — Set Slack notifications for text mention events to On or Off, or omit to leave unchanged.
  • teams — Thread — Set Microsoft Teams notifications for thread events to On or Off, or omit to leave unchanged.
  • teams — Text Mention — Set Microsoft Teams notifications for text mention events to On or Off, or omit to leave unchanged.
  • webPush — Thread — Set web push notifications for thread events to On or Off, or omit to leave unchanged.
  • webPush — Text Mention — Set web push notifications for text mention events to On or Off, or omit to leave unchanged.

Output shape

a single JSON object representing the updated notification settings for the user

The output contains the updated notification settings per channel and event type. Omitting a field in input keeps its current setting unchanged. Errors may include additional debug information if enabled.

Links

Discussion