Get notification details (v0.0.1)

GET request that will return detailed information about a specific notification, identified by its notificationId.

Overview

The GetNotificationDetails message is a query used to retrieve detailed information about a specific notification identified by its notificationId. It provides a comprehensive overview of the notification, including the title, message content, status (read/unread), the date it was created, and any additional metadata related to the notification, such as associated orders or system events. This query is helpful in scenarios where users or systems need detailed insights into a particular notification, such as retrieving full messages or auditing notifications sent to users.

Use cases include viewing detailed information about order updates, system notifications, or promotional messages, allowing users to view their full notification history and details.

JSON Schema

notificationId string
required

The unique identifier for the notification.

title string
required

The title or subject of the notification.

message string
required

The content or message body of the notification.

status string
required

The read status of the notification.

Allowed values: unread read
userId string
required

The unique identifier for the user who received the notification.

createdAt string <date-time>
required

The date and time when the notification was created.

type string
required

The type of the notification, such as order or system.

metadata object

Additional metadata related to the notification, such as order details.