Send mention notifications to mentioned users
curl --request POST \
--url https://your-instance.example.com/api/notifications/mentions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"mentions": [
"65b1f0a2c3d4e5f6a7b8c9d0",
"65b1f0a2c3d4e5f6a7b8c9d1"
],
"noteContent": "@alice @brenda please review this lead",
"authorName": "Cory Tan"
}
'import requests
url = "https://your-instance.example.com/api/notifications/mentions"
payload = {
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"mentions": ["65b1f0a2c3d4e5f6a7b8c9d0", "65b1f0a2c3d4e5f6a7b8c9d1"],
"noteContent": "@alice @brenda please review this lead",
"authorName": "Cory Tan"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '65c2d0e0f0a0b0c0d0e0f0a0',
mentions: ['65b1f0a2c3d4e5f6a7b8c9d0', '65b1f0a2c3d4e5f6a7b8c9d1'],
noteContent: '@alice @brenda please review this lead',
authorName: 'Cory Tan'
})
};
fetch('https://your-instance.example.com/api/notifications/mentions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/notifications/mentions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '65c2d0e0f0a0b0c0d0e0f0a0',
'mentions' => [
'65b1f0a2c3d4e5f6a7b8c9d0',
'65b1f0a2c3d4e5f6a7b8c9d1'
],
'noteContent' => '@alice @brenda please review this lead',
'authorName' => 'Cory Tan'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/notifications/mentions"
payload := strings.NewReader("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\",\n \"65b1f0a2c3d4e5f6a7b8c9d1\"\n ],\n \"noteContent\": \"@alice @brenda please review this lead\",\n \"authorName\": \"Cory Tan\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/notifications/mentions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\",\n \"65b1f0a2c3d4e5f6a7b8c9d1\"\n ],\n \"noteContent\": \"@alice @brenda please review this lead\",\n \"authorName\": \"Cory Tan\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/notifications/mentions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\",\n \"65b1f0a2c3d4e5f6a7b8c9d1\"\n ],\n \"noteContent\": \"@alice @brenda please review this lead\",\n \"authorName\": \"Cory Tan\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Mention notifications sent",
"notifications": 2,
"recipients": [
"65b1f0a2c3d4e5f6a7b8c9d0",
"65b1f0a2c3d4e5f6a7b8c9d1"
]
}{
"success": false,
"error": "Notification not found"
}{
"success": false,
"error": "Notification not found"
}Notification
Send mention notifications to mentioned users
Fan-out helper called by note/comment surfaces when one or more @user mentions are detected. Creates a notification per mentioned user (excluding the author) and returns the recipient list.
POST
/
api
/
notifications
/
mentions
Send mention notifications to mentioned users
curl --request POST \
--url https://your-instance.example.com/api/notifications/mentions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"mentions": [
"65b1f0a2c3d4e5f6a7b8c9d0",
"65b1f0a2c3d4e5f6a7b8c9d1"
],
"noteContent": "@alice @brenda please review this lead",
"authorName": "Cory Tan"
}
'import requests
url = "https://your-instance.example.com/api/notifications/mentions"
payload = {
"contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
"mentions": ["65b1f0a2c3d4e5f6a7b8c9d0", "65b1f0a2c3d4e5f6a7b8c9d1"],
"noteContent": "@alice @brenda please review this lead",
"authorName": "Cory Tan"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '65c2d0e0f0a0b0c0d0e0f0a0',
mentions: ['65b1f0a2c3d4e5f6a7b8c9d0', '65b1f0a2c3d4e5f6a7b8c9d1'],
noteContent: '@alice @brenda please review this lead',
authorName: 'Cory Tan'
})
};
fetch('https://your-instance.example.com/api/notifications/mentions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/notifications/mentions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '65c2d0e0f0a0b0c0d0e0f0a0',
'mentions' => [
'65b1f0a2c3d4e5f6a7b8c9d0',
'65b1f0a2c3d4e5f6a7b8c9d1'
],
'noteContent' => '@alice @brenda please review this lead',
'authorName' => 'Cory Tan'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/notifications/mentions"
payload := strings.NewReader("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\",\n \"65b1f0a2c3d4e5f6a7b8c9d1\"\n ],\n \"noteContent\": \"@alice @brenda please review this lead\",\n \"authorName\": \"Cory Tan\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/notifications/mentions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\",\n \"65b1f0a2c3d4e5f6a7b8c9d1\"\n ],\n \"noteContent\": \"@alice @brenda please review this lead\",\n \"authorName\": \"Cory Tan\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/notifications/mentions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"65c2d0e0f0a0b0c0d0e0f0a0\",\n \"mentions\": [\n \"65b1f0a2c3d4e5f6a7b8c9d0\",\n \"65b1f0a2c3d4e5f6a7b8c9d1\"\n ],\n \"noteContent\": \"@alice @brenda please review this lead\",\n \"authorName\": \"Cory Tan\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Mention notifications sent",
"notifications": 2,
"recipients": [
"65b1f0a2c3d4e5f6a7b8c9d0",
"65b1f0a2c3d4e5f6a7b8c9d1"
]
}{
"success": false,
"error": "Notification not found"
}{
"success": false,
"error": "Notification not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Contact the note relates to (links the notification back to the timeline).
User _ids @-mentioned in the note; each receives a ping.
Plain-text excerpt rendered inside the notification body.
Display name of the user who authored the note.
Response
Mention notifications sent
⌘I