Notifications

The notification object

An in-app notification addressed to a single user, shown in their notification (bell) feed.

A notification belongs to one user in one account, so the feed you read is always that of the authenticated caller in the account they are acting in. Announcements broadcast to a whole account are a separate resource.

idstring

Notification ID.

objectstringenumValues:notification

Resource type identifier.

categorystringenumValues:chat.messagechat.mentionchat.added

The kind of event this notification represents.

The set is open-ended and may grow over time. Common first-party categories are:

chat.message: a new message in a conversation.
chat.mention: a direct @mention, delivered even when the conversation is muted.
chat.added: the user was added to a conversation.
order.updated: an order the user is involved with changed.
agent.run_completed: an agent run the user triggered finished.
agent.alert: an agent raised an alert during a run.
system.broadcast: a targeted system message.
customer.registered: a buyer completed registration on your customer portal.

titlestring

Short headline shown in the feed.

bodystringnullable

Supporting detail shown beneath the title, such as a preview of the message that triggered the notification.

statusstringenumValues:unseenseenread

Where the notification is in its lifecycle.

unseen: delivered but not yet surfaced to the user.
seen: surfaced in the feed but not yet opened.
read: explicitly opened by the user.
dismissed: removed from the active feed.

The status is derived from the seen, read, and dismissed timestamps, and only ever moves forward — a notification can never become unseen again.

prioritystringenumValues:lownormalhigh

How prominently the notification should be surfaced, from low through urgent.

senderactornullable

The actor that generated this notification.

Notifications raised by the platform itself, rather than by a person, agent, or API key, have no sender.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

The role the actor holds in the account, which determines what it is permitted to do.

Always returned as null in this endpoint.

resourceentitynullable

The resource this notification is about, which the client can link to.

Chat notifications point at the conversation the message was posted in — or at the support case, for customer-facing threads — so opening the notification opens the thread.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

seen_atstring (date-time)nullable

When the notification was first surfaced to the user.

read_atstring (date-time)nullable

When the notification was explicitly opened.

dismissed_atstring (date-time)nullable

When the notification was dismissed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Used by

POSTSend NotificationNotifications GETList NotificationsNotifications GETGet Notification Unread CountNotifications GETGet Cross-Account Unread SummaryNotifications GETRetrieve NotificationNotifications POSTMark All Notifications SeenNotifications POSTDismiss NotificationNotifications POSTMark Notification ReadNotifications POSTMark Notification SeenNotifications

notification example

{
  "id": "nf_yvw2bfj2guyn",
  "object": "notification",
  "category": "order.updated",
  "title": "Order updated",
  "body": "Order #1024 changed from estimate to confirmed.",
  "status": "unseen",
  "priority": "normal",
  "sender": {
    "id": "acus_e5zu8bde0z3h",
    "object": "actor",
    "type": "user",
    "name": "Jie Yan",
    "handle": null,
    "avatar_url": null,
    "role": null
  },
  "resource": {
    "id": "or_9lqo07quiwyb",
    "object": "entity",
    "type": "sales_order",
    "name": "SO-001",
    "handle": null
  },
  "seen_at": null,
  "read_at": null,
  "dismissed_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "nf_yvw2bfj2guyn",
  "object": "notification",
  "category": "order.updated",
  "title": "Order updated",
  "body": "Order #1024 changed from estimate to confirmed.",
  "status": "unseen",
  "priority": "normal",
  "sender": {
    "id": "acus_e5zu8bde0z3h",
    "object": "actor",
    "type": "user",
    "name": "Jie Yan",
    "handle": null,
    "avatar_url": null,
    "role": null
  },
  "resource": {
    "id": "or_9lqo07quiwyb",
    "object": "entity",
    "type": "sales_order",
    "name": "SO-001",
    "handle": null
  },
  "seen_at": null,
  "read_at": null,
  "dismissed_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Notifications

Attributes

Used by