Admin
Notifications
List, add, or delete user notifications.
POST
/
admin
/
notifications
Notifications
curl --request POST \
--url https://api.example.com/admin/notifications \
--header 'Content-Type: application/json' \
--data '
{
"action": "<string>",
"data": {
"filter": "<string>"
}
}
'import requests
url = "https://api.example.com/admin/notifications"
payload = {
"action": "<string>",
"data": { "filter": "<string>" }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({action: '<string>', data: {filter: '<string>'}})
};
fetch('https://api.example.com/admin/notifications', 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://api.example.com/admin/notifications",
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([
'action' => '<string>',
'data' => [
'filter' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/admin/notifications"
payload := strings.NewReader("{\n \"action\": \"<string>\",\n \"data\": {\n \"filter\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/admin/notifications")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"<string>\",\n \"data\": {\n \"filter\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"<string>\",\n \"data\": {\n \"filter\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{}
],
"message": "<string>"
}List, add, or delete notifications. Dispatch the desired operation with the
action field in the request body.
Actions
| Action | Description |
|---|---|
list | List notifications with optional filter. |
add | Create a new notification. |
delete | Remove a notification by id. |
Request body
string
required
One of
list, add, or delete.object
Payload for the selected action. Required for
add and delete.Show list
Show list
string
default:"all"
all, unread, visual, health, or flow.Response
array
Returned by
list. Each Notification includes id, user_id, type, title, body, test_kind, link, read_at, dismissed_at, and created_at.string
Human-readable status message.
⌘I
Notifications
curl --request POST \
--url https://api.example.com/admin/notifications \
--header 'Content-Type: application/json' \
--data '
{
"action": "<string>",
"data": {
"filter": "<string>"
}
}
'import requests
url = "https://api.example.com/admin/notifications"
payload = {
"action": "<string>",
"data": { "filter": "<string>" }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({action: '<string>', data: {filter: '<string>'}})
};
fetch('https://api.example.com/admin/notifications', 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://api.example.com/admin/notifications",
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([
'action' => '<string>',
'data' => [
'filter' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/admin/notifications"
payload := strings.NewReader("{\n \"action\": \"<string>\",\n \"data\": {\n \"filter\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/admin/notifications")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"<string>\",\n \"data\": {\n \"filter\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"<string>\",\n \"data\": {\n \"filter\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{}
],
"message": "<string>"
}