Sign in
Notifications

Get inbox notification

Changed on

This endpoint returns a user’s inbox notification by its ID. Corresponds to liveblocks.getInboxNotification.

get/users/{userId}/inbox-notifications/{inboxNotificationId}

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/users/{userId}/inbox-notifications/{inboxNotificationId}
  • Auth: none declared

Path parameters

userIdstring required

ID of the user

Example:user-123
inboxNotificationIdstring required

ID of the inbox notification

Example:in_abc123

Response

Success. Returns the inbox notification.

OR

Example response

{
  "kind": "thread",
  "id": "in_abc123",
  "roomId": "my-room-id",
  "organizationId": "org_123456789",
  "threadId": "th_abc123",
  "notifiedAt": "2024-01-15T10:30:00.000Z",
  "readAt": null
}

Changes

  • 27df578098d7Revision changes
    • info

      added the optional property / to the response with the status

  • 77cd6a75b2b7Revision changes
    • breaking

      response property oneOf[subschema #1: InboxNotificationThreadData]/readAt list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property oneOf[subschema #2: InboxNotificationCustomData]/readAt list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property oneOf[subschema #2: InboxNotificationCustomData]/roomId list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id get-users-userId-inboxNotifications-inboxNotificationId removed and replaced with get-inbox-notification

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property const value custom was added for the status

    • info

      added the required property / to the response with the status