DevelopersSystem notifications
System notifications API
List platform-wide RequestRocket notices with the Core API.
Use the Core API to list platform-wide system notifications available to authenticated users.
Endpoint
| Method | Path | Description |
|---|---|---|
GET | /api/notifications | List all system notifications |
There is no single-item route. POST, PUT, and DELETE return 405.
List system notifications
Request
curl -X GET "https://api.requestrocket.com/api/notifications" \
-H "Authorization: u-your-token"import axios from "axios";
const response = await axios.request({
method: "GET",
url: "https://api.requestrocket.com/api/notifications",
headers: {
"Authorization": "u-your-token",
}
});
console.log(response.status, response.data);import requests
response = requests.request(
"GET",
"https://api.requestrocket.com/api/notifications",
headers={
"Authorization": "u-your-token",
}
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
var payload io.Reader
req, _ := http.NewRequest("GET", "https://api.requestrocket.com/api/notifications", payload)
req.Header.Set("Authorization", "u-your-token")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(resp.StatusCode, string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.requestrocket.com/api/notifications"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.header("Authorization", "u-your-token")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Responses
{
"systemNotifications": [
{
"sKey": "notification-id",
"title": "Platform notice",
"message": "Notification details",
"severity": "info",
"notificationCreatedAt": "notification-created-at"
}
],
"message": "Notifications retrieved successfully"
}{
"message": "Failed to retrieve notifications"
}Query parameters
None.
Response attributes
| Attribute | Type | Description |
|---|---|---|
systemNotifications | array | Platform-wide notices. |
systemNotifications[].sKey | string | Notification id. |
systemNotifications[].title | string | Title. |
systemNotifications[].message | string | Body. |
systemNotifications[].severity | string | info, warning, or critical. |
systemNotifications[].notificationCreatedAt | string | Creation time. |
message | string | Notifications retrieved successfully. |
Shared status codes and request limits are on Platform limits.