Skip to main content

UserNotification

An in-app notification for a staff user. Buyer notifications are a separate type.

type UserNotification {
  body: String!
  createdAt: DateTime!
  entityId: String
  entityType: String
  id: ID!
  metadata: JSON
  readAt: DateTime
  title: String!
  type: String!
  updatedAt: DateTime!
}

Fields​

UserNotification.body ● String! non-null scalar​

The text.

UserNotification.createdAt ● DateTime! non-null scalar​

When the record was created.

UserNotification.entityId ● String scalar​

The ID of that record.

UserNotification.entityType ● String scalar​

The kind of record the notification links to, for example SALES_ORDER or INVOICE.

UserNotification.id ● ID! non-null scalar​

The unique ID of this record.

UserNotification.metadata ● JSON scalar​

Additional data attached to the record, as JSON.

UserNotification.readAt ● DateTime scalar​

When it was read. Empty means unread, which drives the bell badge.

UserNotification.title ● String! non-null scalar​

The title.

UserNotification.type ● String! non-null scalar​

What the notification is about, for example ORDER_STATUS, COLLECTION_REMINDER or SYSTEM.

UserNotification.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Returned By​

markNotificationRead mutation ● visitMessages query

Member Of​

UserNotificationPage object