Notifications

The Notifications module manages workspace notifications, notification rules, notification preferences, and subscriptions.

What it does

Use Notifications when a workflow needs visible alerts or user-specific delivery preferences:

  • Create notifications for workspace events, assignments, escalations, approvals, and operational updates.
  • Define notification rules for event types, source objects, channels, or recipients.
  • Store user preferences for notification behavior.
  • Manage browser or delivery subscriptions for workspace users.
  • Link notifications to CRM, Support, Tasks, Projects, Products, Calendar, CMS, Data Agents, or AgentGrid activity.

Resource model

ResourcePurpose
workspace_notificationsNotification records with recipient, status, source object, and event context.
workspace_notification_rulesRules that decide when notifications should be created or delivered.
workspace_notification_preferencesUser or workspace preferences for notification channels and event types.
workspace_notification_subscriptionsBrowser or delivery subscriptions for workspace notifications.

REST surface

Notifications REST endpoints live under /v1/notifications...:

  • GET /v1/notifications
  • POST /v1/notifications
  • PATCH /v1/notifications/{notification_id}
  • GET /v1/notifications/rules
  • POST /v1/notifications/rules
  • PATCH /v1/notifications/rules/{rule_id}
  • GET /v1/notifications/preferences
  • POST /v1/notifications/preferences
  • PATCH /v1/notifications/preferences/{preference_id}
  • GET /v1/notifications/subscriptions
  • POST /v1/notifications/subscriptions
  • PATCH /v1/notifications/subscriptions/{subscription_id}

All routes require the Notifications module to be enabled for the workspace before scope checks can succeed.

Permissions

Use notifications:read to list notifications, rules, preferences, and subscriptions. Use notifications:write to create or update notification records.

Recommended scoped credentials for notification workflows:

notifications:read
notifications:write
tasks:read
support:read
activity:write

Add write scopes for source modules only when the workflow is allowed to update the source records that triggered the notification.

Example workflow

Prompt:

Create a notification rule for urgent support tickets, notify the support owner when a ticket is escalated, and record the notification setup in Activity Log.

Expected operations:

  1. Create or update the notification rule.
  2. Create a notification tied to the support ticket or escalation event.
  3. Respect the recipient's notification preferences.
  4. Use the subscription records for browser or delivery routing when available.
  5. Log the configuration activity.

Audit and usage

Notification writes create audit events and usage events with request IDs. Use request IDs to connect a notification to the source object, rule, preference, subscription, and related activity entry.

MCP guidance

Notification records are available through REST. Dedicated MCP tools are not listed in the public MCP tool registry for this module. Agent workflows can combine REST notification records with MCP tools from Tasks, Support, Activity Log, CRM, Data Agents, and AgentGrid.

Was this page helpful?