Notifications appear in multiple locations (bell icon, email, etc.) inside the platform and alert users of actions inside their workflows, like due dates, updates, and more.

The bell icon is where users receive notifications relevant only to themselves. By default, they will also receive an email when they get a notification, which can be turned off and customized in the userโ€™s profile settings.

We don't support any queries to read notifications via the API. This document will walk you through the available mutations to create notifications via the API.

Mutations

Required scope: notifications:write

Create a notification

The create_notification mutation allows you to send 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. Please note that this mutation only sends the notification; you can't query back the notification ID when running the mutation, as notifications are asynchronous.

If you send a notification from a board view or widget using seamless authentication, it will come 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.

Check out this mutation in action in our Postman library or follow along with these code samples!

mutation {
  create_notification (user_id: 12345678, target_id: 674387, text: "This is a notification", target_type: Project) {
    text
  }
}
let query = "mutation { create_notification (user_id: 12345678, target_id: 674387, text: \"This is a notification\", target_type: project) { text } }";

fetch ("https://api.monday.com/v2", {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to define the new notification's characteristics.

ArgumentDescription
target_type NotificationTargetType!The target's type: project or post.
- Project: sends a notification referring to a specific item or board
- Post : sends a notification referring to a specific item's update or reply
target_id ID!The target's unique identifier. The value depends on the target_type:
- Project: the relevant item or board ID
- Post : the relevant update or reply ID
text String!The notification's text.
user_id ID!The user's unique identifier.

๐Ÿ“˜

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! ๐Ÿ˜Ž