Notifications alert users of platform activities, such as due dates, updates, and more. They appear in multiple locations, including the bell icon and email.

Notifications relevant only to the signed-in user appear under the bell icon. By default, they will also receive an email whenever they get a notification. This can be turned off and customized in the user’s profile settings.

Queries

You can use the notifications query to retrieve notification data via the API.

• Returns metadata about a user's notifications
• Can only be queried directly at the root; can't be nested within another query

query {
  notifications(filter_read: true) {
		text
    title
    id
  }
}

{
  "data": {
    "notifications": [
      {
        "text": "This is a notification",
        "title": "New test notification",
        "id": "123456"
      }
    ]
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Arguments

You can use the following arguments to reduce the number of results returned in your notifications query.

Fields

You can use the following fields to specify what information your notifications query will return.

Mutations

The API allows you to create notifications using the following mutation.

Create notification

Required scope:notifications:write

The create_notification mutation sends a notification to the bell icon via the API. Doing so may also send an email if the recipient's email preferences are set up accordingly.

If you send a notification from a board view or widget using seamless authentication, it will be sent from the app and display its name and icon. If you use a personal API key to make the call, the notification will appear to come from the user who installed the app on the account.

This mutation only sends the notification. Since notifications are asynchronous, you can't query back the notification ID when running the mutation.

mutation {
  create_notification(
    user_id: 12345678
    target_id: 674387
    text: "This is a notification"
    target_type: Project
  ) {
    text
  }
}

Arguments

You can use the following arguments to define the new notification's characteristics.