Notifications

A notification delivered to a user, triggered by an event such as an order
fill, document approval, or role change.

Fields

Fields on the Notification object.

Field	Type	Description
`id`	`ID!`	—
`createdAt`	`Time!`	—
`readAt`	`Time`	Timestamp when the user read this notification. Null if unread.
`reference`	`NotificationReference`	The entity that triggered this notification (e.g., an order or document).

Queries

Root queries that return or operate on this object.

`notification`

Returns a single notification by ID.

type Query {
  notification(id: ID!): Notification
}

Arguments

Argument	Type	Description
`id`	`ID!`	—

Returns

Notification

Mutations

Root mutations that create, update, or otherwise change this object.

`readNotification`

Marks a notification as read. Audit-logged.

type Mutation {
  readNotification(input: ReadNotificationInput!): ReadNotificationPayload!
}

Arguments

Argument	Type	Description
`input`	`ReadNotificationInput!`	—

Returns

ReadNotificationPayload

Related types

Supporting objects, inputs, and enums used by this page.

Objects

`NotificationConnection`

Type: object

Relay connection for paginated Notification results.

Fields

Field	Type	Description
`nodes`	`[Notification]!`	—
`edges`	`[NotificationEdge!]!`	—
`pageInfo`	`PageInfo!`	—
`totalCount`	`Int!`	—

`NotificationEdge`

Type: object

Relay edge wrapping a Notification node with its pagination cursor.

Fields

Field	Type	Description
`cursor`	`String!`	—
`node`	`Notification!`	—

`ReadNotificationPayload`

Type: object

Response payload for the readNotification mutation.

Fields

Field	Type	Description
`success`	`Boolean!`	—

Interfaces

`NotificationReference`

Type: interface

Interface for entities that can trigger a notification.

Fields

Field	Type	Description
`id`	`ID!`	—

Inputs

`ReadNotificationInput`

Type: input

Input for marking a notification as read.

Fields

Field	Type	Description
`notificationId`	`String!`	—