{ "info": { "_postman_id": "9256d4c7-4fe2-4bb3-9ae2-5269a1923290", "name": "ThingsBoard Admin admin-controller notification-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "lastUpdatedBy": "35240", "uid": "35240-9256d4c7-4fe2-4bb3-9ae2-5269a1923290" }, "item": [ { "name": "api", "item": [ { "name": "notifications", "item": [ { "name": "read", "item": [ { "name": "Mark All Notifications as Read (markAllNotificationsAsRead)", "id": "18b6e460-d870-40ee-b028-a874c74ac704", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/api/notifications/read?deliveryMethod=WEB", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "read" ], "query": [ { "description": "Delivery method", "key": "deliveryMethod", "value": "WEB" } ] }, "description": "Marks all unread notifications as read.\n\nAvailable for any authorized user. " }, "response": [ { "id": "51986781-282c-4995-973e-59074897c588", "name": "OK", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/api/notifications/read?deliveryMethod=WEB", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "read" ], "query": [ { "description": "Delivery method", "key": "deliveryMethod", "value": "WEB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-51986781-282c-4995-973e-59074897c588" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-18b6e460-d870-40ee-b028-a874c74ac704" } ], "id": "66a9d2c1-4336-4cee-bd0f-358646bce407", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-66a9d2c1-4336-4cee-bd0f-358646bce407" }, { "name": "unread", "item": [ { "name": "count", "item": [ { "name": "Get Unread Notifications Count (getUnreadNotificationsCount)", "id": "63059f90-49a4-4558-a04d-577439c0f08f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications/unread/count?deliveryMethod=WEB", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "unread", "count" ], "query": [ { "description": "Delivery method", "key": "deliveryMethod", "value": "WEB" } ] }, "description": "Returns unread notifications count for chosen delivery method.\n\nAvailable for any authorized user. " }, "response": [ { "id": "62fa6002-7c2e-4c7a-ae8a-3fcb3be7547d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications/unread/count?deliveryMethod=WEB", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "unread", "count" ], "query": [ { "description": "Delivery method", "key": "deliveryMethod", "value": "WEB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-62fa6002-7c2e-4c7a-ae8a-3fcb3be7547d" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-63059f90-49a4-4558-a04d-577439c0f08f" } ], "id": "fb51604d-91e5-4397-b075-93fc8cd5877b", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-fb51604d-91e5-4397-b075-93fc8cd5877b" } ], "id": "53184811-aa89-4913-af49-43aacf4cd64e", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-53184811-aa89-4913-af49-43aacf4cd64e" }, { "name": "Get Notifications (getNotifications)", "id": "7e703589-0fbd-432d-a522-0ce41f45028f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications?pageSize=&page=&textSearch=&sortProperty=&sortOrder=&unreadOnly=false&deliveryMethod=WEB", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on notification subject or text", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" }, { "description": "To search for unread notifications only", "key": "unreadOnly", "value": "false" }, { "description": "Delivery method", "key": "deliveryMethod", "value": "WEB" } ] }, "description": "Returns the page of notifications for current user.\n\nYou can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. \n\nAvailable for any authorized user. \n\n**WebSocket API**:\n\nThere are 2 types of subscriptions: one for unread notifications count, another for unread notifications themselves.\n\nThe URI for opening WS session for notifications: `/api/ws/plugins/notifications`.\n\nSubscription command for unread notifications count:\n```\n{\n \"unreadCountSubCmd\": {\n \"cmdId\": 1234\n }\n}\n```\nTo subscribe for latest unread notifications:\n```\n{\n \"unreadSubCmd\": {\n \"cmdId\": 1234,\n \"limit\": 10\n }\n}\n```\nTo unsubscribe from any subscription:\n```\n{\n \"unsubCmd\": {\n \"cmdId\": 1234\n }\n}\n```\nTo mark certain notifications as read, use following command:\n```\n{\n \"markAsReadCmd\": {\n \"cmdId\": 1234,\n \"notifications\": [\n \"6f860330-7fc2-11ed-b855-7dd3b7d2faa9\",\n \"5b6dfee0-8d0d-11ed-b61f-35a57b03dade\"\n ]\n }\n}\n\n```\nTo mark all notifications as read:\n```\n{\n \"markAllAsReadCmd\": {\n \"cmdId\": 1234\n }\n}\n```\n\n\nUpdate structure for unread **notifications count subscription**:\n```\n{\n \"cmdId\": 1234,\n \"totalUnreadCount\": 55\n}\n```\nFor **notifications subscription**:\n- full update of latest unread notifications:\n```\n{\n \"cmdId\": 1234,\n \"notifications\": [\n {\n \"id\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"6f860330-7fc2-11ed-b855-7dd3b7d2faa9\"\n },\n ...\n }\n ],\n \"totalUnreadCount\": 1\n}\n```\n- when new notification arrives or shown notification is updated:\n```\n{\n \"cmdId\": 1234,\n \"update\": {\n \"id\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"6f860330-7fc2-11ed-b855-7dd3b7d2faa9\"\n },\n # updated notification info, text, subject etc.\n ...\n },\n \"totalUnreadCount\": 2\n}\n```\n- when unread notifications count changes:\n```\n{\n \"cmdId\": 1234,\n \"totalUnreadCount\": 5\n}\n```" }, "response": [ { "id": "159ad819-02e1-4440-a0ef-fa2fa330452a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications?pageSize=&page=&textSearch=&sortProperty=&sortOrder=&unreadOnly=false&deliveryMethod=WEB", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on notification subject or text", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" }, { "description": "To search for unread notifications only", "key": "unreadOnly", "value": "false" }, { "description": "Delivery method", "key": "deliveryMethod", "value": "WEB" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"requestId\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"recipientId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"RESOURCES_SHORTAGE\",\n \"deliveryMethod\": \"SMS\",\n \"subject\": \"\",\n \"text\": \"\",\n \"additionalConfig\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"MOBILE_APP_BUNDLE\",\n \"id\": \"\"\n }\n },\n \"status\": \"SENT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n },\n {\n \"requestId\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"recipientId\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"type\": \"EDGE_CONNECTION\",\n \"deliveryMethod\": \"MOBILE_APP\",\n \"subject\": \"\",\n \"text\": \"\",\n \"additionalConfig\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"\"\n }\n },\n \"status\": \"SENT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-159ad819-02e1-4440-a0ef-fa2fa330452a" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-7e703589-0fbd-432d-a522-0ce41f45028f" } ], "id": "d1314325-ca46-4193-bb3a-fad416254829", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-d1314325-ca46-4193-bb3a-fad416254829" }, { "name": "notification", "item": [ { "name": "{id}", "item": [ { "name": "read", "item": [ { "name": "Mark Notification as Read (markNotificationAsRead)", "id": "d69eac3b-d0c8-4443-9645-06904e4d601a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/:id/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", ":id", "read" ], "variable": [ { "id": "c3ac5904-baa8-48a7-a1af-45d9ab21b785", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Marks notification as read by its id.\n\nAvailable for any authorized user. " }, "response": [ { "id": "fbeeb18f-969d-43f0-b31e-0a7847015b20", "name": "OK", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/:id/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", ":id", "read" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-fbeeb18f-969d-43f0-b31e-0a7847015b20" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-d69eac3b-d0c8-4443-9645-06904e4d601a" } ], "id": "88f1244b-5eda-4de9-822c-bb6a4908d971", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-88f1244b-5eda-4de9-822c-bb6a4908d971" }, { "name": "Delete Notification (deleteNotification)", "id": "0a06052f-788e-47a1-847a-f55e70513100", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", ":id" ], "variable": [ { "id": "c1fe8394-c9fe-4395-99d3-8971e03fe69d", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Deletes notification by its id.\n\nAvailable for any authorized user. " }, "response": [ { "id": "28041238-9299-41f6-bd56-d568d47782e3", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-28041238-9299-41f6-bd56-d568d47782e3" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-0a06052f-788e-47a1-847a-f55e70513100" } ], "id": "784f24cf-2b3d-4239-972f-a0f9c51d6c63", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-784f24cf-2b3d-4239-972f-a0f9c51d6c63" }, { "name": "settings", "item": [ { "name": "user", "item": [ { "name": "get User Notification Settings", "id": "08b03cf1-85f6-4c67-bd19-d41c6f0c2fdc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/settings/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings", "user" ] } }, "response": [ { "id": "89e31806-e72f-4581-b9a6-12ff2f59e2c5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/settings/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings", "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"prefs\": {\n \"in4\": {\n \"enabledDeliveryMethods\": {\n \"Duis_e4\": \"\",\n \"amet61b\": \"\"\n },\n \"enabled\": \"\"\n },\n \"qui6\": {\n \"enabledDeliveryMethods\": {\n \"esse0\": \"\"\n },\n \"enabled\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-89e31806-e72f-4581-b9a6-12ff2f59e2c5" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-08b03cf1-85f6-4c67-bd19-d41c6f0c2fdc" }, { "name": "save User Notification Settings", "id": "9bec7481-9714-4869-9934-560684d0b4b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prefs\": {\n \"in4\": {\n \"enabledDeliveryMethods\": {\n \"Duis_e4\": \"\",\n \"amet61b\": \"\"\n },\n \"enabled\": \"\"\n },\n \"qui6\": {\n \"enabledDeliveryMethods\": {\n \"esse0\": \"\"\n },\n \"enabled\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/settings/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings", "user" ] } }, "response": [ { "id": "66ed9d9e-14fd-411c-abb6-2a0808b393f1", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prefs\": {\n \"in4\": {\n \"enabledDeliveryMethods\": {\n \"Duis_e4\": \"\",\n \"amet61b\": \"\"\n },\n \"enabled\": \"\"\n },\n \"qui6\": {\n \"enabledDeliveryMethods\": {\n \"esse0\": \"\"\n },\n \"enabled\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/settings/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings", "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"prefs\": {\n \"in4\": {\n \"enabledDeliveryMethods\": {\n \"Duis_e4\": \"\",\n \"amet61b\": \"\"\n },\n \"enabled\": \"\"\n },\n \"qui6\": {\n \"enabledDeliveryMethods\": {\n \"esse0\": \"\"\n },\n \"enabled\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-66ed9d9e-14fd-411c-abb6-2a0808b393f1" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-9bec7481-9714-4869-9934-560684d0b4b1" } ], "id": "3bb6b5d8-ce65-4b71-983e-ac5fe65758c0", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-3bb6b5d8-ce65-4b71-983e-ac5fe65758c0" }, { "name": "Get Notification Settings (getNotificationSettings)", "id": "faeaba3f-6b2b-4a82-a5a9-db5f6f618572", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings" ] }, "description": "Retrieves notification settings for this tenant or sysadmin.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "4132fcbe-cd39-4c26-9a45-2dd735266b9f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deliveryMethodsConfigs\": {\n \"occaecat_65\": {\n \"firebaseServiceAccountCredentials\": \"\",\n \"method\": \"\",\n \"firebaseServiceAccountCredentialsFileName\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-4132fcbe-cd39-4c26-9a45-2dd735266b9f" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-faeaba3f-6b2b-4a82-a5a9-db5f6f618572" }, { "name": "Save Notification Settings (saveNotificationSettings)", "id": "bbb38aca-5376-4a1d-87ab-286d367ba5bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deliveryMethodsConfigs\": {\n \"occaecat_65\": {\n \"firebaseServiceAccountCredentials\": \"\",\n \"method\": \"\",\n \"firebaseServiceAccountCredentialsFileName\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings" ] }, "description": "Saves notification settings for this tenant or sysadmin.\n`deliveryMethodsConfigs` of the settings must be specified.\n\nHere is an example of the notification settings with Slack configuration:\n```json\n{\n \"deliveryMethodsConfigs\": {\n \"SLACK\": {\n \"method\": \"SLACK\",\n \"botToken\": \"xoxb-....\"\n }\n }\n}\n```\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "cf430355-31c9-45d4-b800-aabd11af1b65", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deliveryMethodsConfigs\": {\n \"occaecat_65\": {\n \"firebaseServiceAccountCredentials\": \"\",\n \"method\": \"\",\n \"firebaseServiceAccountCredentialsFileName\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deliveryMethodsConfigs\": {\n \"occaecat_65\": {\n \"firebaseServiceAccountCredentials\": \"\",\n \"method\": \"\",\n \"firebaseServiceAccountCredentialsFileName\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-cf430355-31c9-45d4-b800-aabd11af1b65" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-bbb38aca-5376-4a1d-87ab-286d367ba5bf" } ], "id": "c4529da3-9e3e-469f-aef6-a90b74c82683", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-c4529da3-9e3e-469f-aef6-a90b74c82683" }, { "name": "request", "item": [ { "name": "preview", "item": [ { "name": "Get Notification Request Preview (getNotificationRequestPreview)", "id": "6e84c30d-2b5a-4c7a-9c03-27b78e6a7d68", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n \"\"\n ],\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"tempord\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"fugiat_14b\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"API_USAGE_LIMIT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"RULE_CHAIN\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SCHEDULED\",\n \"stats\": {\n \"sent\": {\n \"ut__3e\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"anim_7\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"ad_bbb\": {\n \"occaecat_3\": \"\",\n \"voluptated\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/request/preview?recipientsPreviewSize=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request", "preview" ], "query": [ { "description": "Amount of the recipients to show in preview", "key": "recipientsPreviewSize", "value": "20" } ] }, "description": "Returns preview for notification request.\n\n`processedTemplates` shows how the notifications for each delivery method will look like for the first recipient of the corresponding notification target.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "8367ef3f-d0e8-45ab-8cb7-47992425ec8f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n \"\"\n ],\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"tempord\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"fugiat_14b\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"API_USAGE_LIMIT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"RULE_CHAIN\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SCHEDULED\",\n \"stats\": {\n \"sent\": {\n \"ut__3e\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"anim_7\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"ad_bbb\": {\n \"occaecat_3\": \"\",\n \"voluptated\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/request/preview?recipientsPreviewSize=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request", "preview" ], "query": [ { "description": "Amount of the recipients to show in preview", "key": "recipientsPreviewSize", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"processedTemplates\": {\n \"et9a7\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"voluptate1\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"fugiat_0e\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n },\n \"totalRecipientsCount\": \"\",\n \"recipientsCountByTarget\": {\n \"pariatur306\": \"\",\n \"culpa_0\": \"\"\n },\n \"recipientsPreview\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-8367ef3f-d0e8-45ab-8cb7-47992425ec8f" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-6e84c30d-2b5a-4c7a-9c03-27b78e6a7d68" } ], "id": "cc56793e-b843-48f6-acff-3c793d4f1ed6", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-cc56793e-b843-48f6-acff-3c793d4f1ed6" }, { "name": "{id}", "item": [ { "name": "Get Notification Request by Id (getNotificationRequestById)", "id": "6c4f86aa-ba39-4bb2-ad6d-063ec26582ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/request/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request", ":id" ], "variable": [ { "id": "cf8182b7-858a-4a28-ae7a-772daeacb95c", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Fetches notification request info by request id.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "8a5b92e0-93c5-451d-85cd-e1997a203758", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/request/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"targets\": [\n \"\"\n ],\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"reprehenderit5f\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"irure8\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"minim9\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"enim_de\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"EDGE_COMMUNICATION_FAILURE\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"ALARM\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SCHEDULED\",\n \"stats\": {\n \"sent\": {\n \"Duis_253\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"aute088\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"aute_7b\": {\n \"labore37\": \"\",\n \"in_b3\": \"\",\n \"ipsumc4_\": \"\"\n },\n \"eua\": {\n \"officia_b\": \"\"\n },\n \"sunt_924\": {\n \"dolor0c2\": \"\",\n \"doloreb3\": \"\"\n },\n \"sunt3a\": {\n \"auteb6\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"templateName\": \"\",\n \"deliveryMethods\": [\n \"MICROSOFT_TEAMS\",\n \"EMAIL\"\n ]\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-8a5b92e0-93c5-451d-85cd-e1997a203758" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-6c4f86aa-ba39-4bb2-ad6d-063ec26582ab" }, { "name": "Delete Notification Request (deleteNotificationRequest)", "id": "8d44bcc6-0abb-49c6-9ee3-afc8b5458503", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/request/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request", ":id" ], "variable": [ { "id": "927913b4-7593-40d9-82fb-879dbd5132f4", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Deletes notification request by its id.\n\nIf the request has status `SENT` - all sent notifications for this request will be deleted. If it is `SCHEDULED`, the request will be cancelled.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "433f3c58-223b-4fc6-9c31-6a679ddb81f7", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/request/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-433f3c58-223b-4fc6-9c31-6a679ddb81f7" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-8d44bcc6-0abb-49c6-9ee3-afc8b5458503" } ], "id": "99522bfb-daf9-494f-9548-090bf04446e6", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-99522bfb-daf9-494f-9548-090bf04446e6" }, { "name": "Create Notification Request (createNotificationRequest)", "id": "0176920d-c73b-4ce7-976b-d6c76be7a711", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n \"\"\n ],\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"tempord\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"fugiat_14b\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"API_USAGE_LIMIT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"RULE_CHAIN\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SCHEDULED\",\n \"stats\": {\n \"sent\": {\n \"ut__3e\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"anim_7\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"ad_bbb\": {\n \"occaecat_3\": \"\",\n \"voluptated\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request" ] }, "description": "Processes notification request.\nMandatory request properties are `targets` (list of targets ids to send notification to), and either `templateId` (existing notification template id) or `template` (to send notification without saving the template).\nOptionally, you can set `sendingDelayInSec` inside the `additionalConfig` field to schedule the notification.\n\nFor each enabled delivery method in the notification template, there must be a target in the `targets` list that supports this delivery method: if you chose `WEB`, `EMAIL` or `SMS` - there must be at least one target in `targets` of `PLATFORM_USERS` type.\nFor `SLACK` delivery method - you need to chose at least one `SLACK` notification target.\n\nNotification request object with `PROCESSING` status will be returned immediately, and the notification sending itself is done asynchronously. After all notifications are sent, the `status` of the request becomes `SENT`. Use `getNotificationRequestById` to see the notification request processing status and some sending stats. \n\nHere is an example of notification request to one target using saved template:\n```json\n{\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"6dbc3670-e4dd-11ed-9401-dbcc5dff78be\"\n },\n \"targets\": [\n \"320e3ed0-d785-11ed-a06c-21dd57dd88ca\"\n ],\n \"additionalConfig\": {\n \"sendingDelayInSec\": 0\n }\n}\n```\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "8ffe9e7c-2981-4ce5-8a25-2937d2b04247", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n \"\"\n ],\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"tempord\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"fugiat_14b\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"API_USAGE_LIMIT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"RULE_CHAIN\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SCHEDULED\",\n \"stats\": {\n \"sent\": {\n \"ut__3e\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"anim_7\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"ad_bbb\": {\n \"occaecat_3\": \"\",\n \"voluptated\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"targets\": [\n \"\"\n ],\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"tempord\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"fugiat_14b\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"API_USAGE_LIMIT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"RULE_CHAIN\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SCHEDULED\",\n \"stats\": {\n \"sent\": {\n \"ut__3e\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"anim_7\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"ad_bbb\": {\n \"occaecat_3\": \"\",\n \"voluptated\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\"\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-8ffe9e7c-2981-4ce5-8a25-2937d2b04247" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-0176920d-c73b-4ce7-976b-d6c76be7a711" } ], "id": "fd22a49d-61c6-4f76-b088-ce77b76b0007", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-fd22a49d-61c6-4f76-b088-ce77b76b0007" }, { "name": "entitiesLimitIncreaseRequest", "item": [ { "name": "{entityType}", "item": [ { "name": "Send Entity Limit Increase Request Notification to System Administrators (sendEntitiesLimitIncreaseRequest)", "id": "1b351f4a-483a-4901-b461-55c2870c67fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/entitiesLimitIncreaseRequest/:entityType", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "entitiesLimitIncreaseRequest", ":entityType" ], "variable": [ { "id": "a79a305c-77b4-4978-b741-3d7378632f5c", "key": "entityType", "value": "DASHBOARD", "description": "(Required) Entity type" } ] }, "description": "Send entity limit increase request notification by Tenant Administrator to System administrators.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "be75c005-b40b-4148-8340-1dbfc5f98776", "name": "OK", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/entitiesLimitIncreaseRequest/:entityType", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "entitiesLimitIncreaseRequest", ":entityType" ], "variable": [ { "key": "entityType" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-be75c005-b40b-4148-8340-1dbfc5f98776" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-1b351f4a-483a-4901-b461-55c2870c67fe" } ], "id": "fded14bb-1b84-4c91-8a66-0411017c0324", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-fded14bb-1b84-4c91-8a66-0411017c0324" } ], "id": "30748195-99c0-4e85-8746-fd641d197147", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-30748195-99c0-4e85-8746-fd641d197147" }, { "name": "requests", "item": [ { "name": "Get Notification Requests (getNotificationRequests)", "id": "66737b9d-05c5-437c-93d3-363c78aec8ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/requests?pageSize=&page=&textSearch=&sortProperty=&sortOrder=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "requests" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filed based on the used template name", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" } ] }, "description": "Returns the page of notification requests submitted by users of this tenant or sysadmins.\n\nYou can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "cd19da7c-01ab-4b0e-a4e2-a04b9220ccea", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/requests?pageSize=&page=&textSearch=&sortProperty=&sortOrder=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "requests" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filed based on the used template name", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"targets\": [\n \"\"\n ],\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"occaecat928\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RESOURCES_SHORTAGE\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"API_USAGE_STATE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"OAUTH2_CLIENT\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"PROCESSING\",\n \"stats\": {\n \"sent\": {\n \"ex_e9_\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"amet_c8\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"nisid0\": {\n \"laboris_cf\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"templateName\": \"\",\n \"deliveryMethods\": [\n \"MICROSOFT_TEAMS\",\n \"EMAIL\"\n ]\n },\n {\n \"targets\": [\n \"\"\n ],\n \"id\": {\n \"entityType\": \"NOTIFICATION_REQUEST\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"templateId\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"template\": {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"aute_9\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RATE_LIMITS\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n \"info\": {\n \"type\": \"\",\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"stateEntityId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n }\n },\n \"additionalConfig\": {\n \"sendingDelayInSec\": \"\"\n },\n \"originatorEntityId\": {\n \"entityType\": \"EDGE\",\n \"id\": \"\"\n },\n \"ruleId\": {\n \"entityType\": \"NOTIFICATION_RULE\",\n \"id\": \"\"\n },\n \"status\": \"SENT\",\n \"stats\": {\n \"sent\": {\n \"nulla_d\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n }\n },\n \"errors\": {\n \"elit_f6\": {\n \"dolor49\": \"\",\n \"nisi5fb\": \"\",\n \"est4b\": \"\"\n }\n },\n \"totalErrors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"error\": \"\"\n },\n \"templateName\": \"\",\n \"deliveryMethods\": [\n \"EMAIL\",\n \"MOBILE_APP\"\n ]\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-cd19da7c-01ab-4b0e-a4e2-a04b9220ccea" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-66737b9d-05c5-437c-93d3-363c78aec8ca" } ], "id": "ed72a08a-9b7a-4882-a4e7-3c1b5903eea7", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-ed72a08a-9b7a-4882-a4e7-3c1b5903eea7" }, { "name": "deliveryMethods", "item": [ { "name": "Get Available Delivery Methods (getAvailableDeliveryMethods)", "id": "d4f5ffce-0545-4854-b0bb-a001ccc355ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/deliveryMethods", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "deliveryMethods" ] }, "description": "Returns the list of delivery methods that are properly configured and are allowed to be used for sending notifications.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "e136212e-8461-486e-bfdd-739889608ec6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/deliveryMethods", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "deliveryMethods" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n \"SLACK\",\n \"EMAIL\"\n]", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-e136212e-8461-486e-bfdd-739889608ec6" } ], "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-d4f5ffce-0545-4854-b0bb-a001ccc355ea" } ], "id": "445901ff-0e42-4104-b9e4-b07b43dae141", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-445901ff-0e42-4104-b9e4-b07b43dae141" } ], "id": "f92459d9-dbfa-4f7c-9d61-a670fc759882", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-f92459d9-dbfa-4f7c-9d61-a670fc759882" } ], "id": "981d7a3f-06e3-46b7-903a-4526ae6290b3", "createdAt": "2026-07-28T03:12:54.000Z", "updatedAt": "2026-07-28T03:12:54.000Z", "uid": "35240-981d7a3f-06e3-46b7-903a-4526ae6290b3" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }