Overview

App notifications allow you to keep your team informed about important updates on the Root Platform. There are two types of notifications:

1. Mentions: Tag team members in notes on Claims, Policies, Applications, Complaints, Members, or Policyholders. Tagged users receive an in-app notification and email.
2. Assignments: Assign claims to team members. Assigned users receive an in-app notification and email.

📘

Using the Dashboard?

If you're using the Root Dashboard to tag team members in notes, see our Help Centre guide.

This guide covers how to use the App notifications API to:

• Create mentions: Tag users when adding notes via API
• Create assignments: Assign claims to users via API
• Retrieve notifications: Fetch notifications for your organisation
• Manage notifications: Mark notifications as read

Prerequisites

Before using App notifications via the API, ensure:

1. You have an API key with the appropriate permissions. See Getting started.
2. Your API key or user has the following permissions:
   • App notifications : Read to retrieve notifications
   • App notifications : Manage to mark notifications as read
   • App notifications : Create to create notifications (via mentions in notes)
3. You have the App notifications feature enabled for your organisation.

Create mentions in notes

To mention users when creating a note, use the rich mention format:

@[Display Name](user-uuid)

This format differs from the dashboard UI where you simply type @ and select a user. When using the API, you must explicitly include the user's UUID.

Adding a note with mentions

Notes can be added to various entities. Here's an example adding a note to a claim:

{
  "text": "Please review this claim @[Alice Smith](d8e72dda-431a-4834-a1f6-10579de4a796) - the documentation looks complete."
}

The mentioned user will receive:

• An in-app notification in the Notifications panel
• An email notification (if email notifications are enabled in their settings)

Supported entities for notes

You can add notes with mentions to the following entities:

Related resources

• Help Centre: Tag team members in a note - Dashboard UI guide
• Help Centre: View and manage your notifications - Dashboard notifications panel
• API Reference: Add a note to a claim
• API Reference: Add a note to a policy