{ "info": { "_postman_id": "90f25734-6ec0-4e3f-af60-3e1bbe608e84", "name": "ThingsBoard Admin admin-controller notification-target-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:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-90f25734-6ec0-4e3f-af60-3e1bbe608e84" }, "item": [ { "name": "api", "item": [ { "name": "notification", "item": [ { "name": "target", "item": [ { "name": "recipients", "item": [ { "name": "Get Recipients for Notification Target Config (getRecipientsForNotificationTargetConfig)", "id": "fb558970-7871-4faf-a9de-cca97d43cdd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/target/recipients?pageSize=&page=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target", "recipients" ], "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": "Returns the page of recipients for such notification target configuration.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "ab85067c-d5a1-4c9d-935c-3836b72dd0cc", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/target/recipients?pageSize=&page=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target", "recipients" ], "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": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"authority\": \"REFRESH_TOKEN\",\n \"email\": \"\",\n \"id\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n },\n {\n \"authority\": \"SYS_ADMIN\",\n \"email\": \"\",\n \"id\": {\n \"entityType\": \"USER\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-ab85067c-d5a1-4c9d-935c-3836b72dd0cc" } ], "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-fb558970-7871-4faf-a9de-cca97d43cdd5" } ], "id": "bbd640d3-20ce-40ec-9406-5203252adac3", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-bbd640d3-20ce-40ec-9406-5203252adac3" }, { "name": "{id}", "item": [ { "name": "Get Notification Target by Id (getNotificationTargetById)", "id": "c6e93093-945b-4000-b2d6-06da73bef9df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/target/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target", ":id" ], "variable": [ { "id": "75d78ddb-5fac-454c-92cc-f93be3b259b3", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Fetches notification target by id.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "00a216a9-3fe0-4c6a-969c-a263d0a64528", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/target/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-00a216a9-3fe0-4c6a-969c-a263d0a64528" } ], "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-c6e93093-945b-4000-b2d6-06da73bef9df" }, { "name": "Delete Notification Target by Id (deleteNotificationTargetById)", "id": "9c74fcb0-0a05-4128-9afa-0752f21f5c71", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/target/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target", ":id" ], "variable": [ { "id": "22f44984-06cc-4551-b356-b12655588732", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Deletes notification target by its id.\n\nThis target cannot be referenced by existing scheduled notification requests or any notification rules.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "0ac59bb4-55d2-44df-932b-f08323edffc0", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/target/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-0ac59bb4-55d2-44df-932b-f08323edffc0" } ], "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-9c74fcb0-0a05-4128-9afa-0752f21f5c71" } ], "id": "1b9ed2ec-db9f-4732-a05b-82ac37326a61", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-1b9ed2ec-db9f-4732-a05b-82ac37326a61" }, { "name": "Save Notification Target (saveNotificationTarget)", "id": "050a99ef-55c5-4807-915e-5f5e9edaa824", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/target", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target" ] }, "description": "Creates or updates notification target.\n\nAvailable `configuration` types are `PLATFORM_USERS` and `SLACK`.\nFor `PLATFORM_USERS` the `usersFilter` must be specified. For tenant, there are following users filter types available: `USER_LIST`, `CUSTOMER_USERS`, `TENANT_ADMINISTRATORS`, `ALL_USERS`, `ORIGINATOR_ENTITY_OWNER_USERS`, `AFFECTED_USER`.\nFor sysadmin: `TENANT_ADMINISTRATORS`, `AFFECTED_TENANT_ADMINISTRATORS`, `SYSTEM_ADMINISTRATORS`, `ALL_USERS`.\n\nHere is an example of tenant-level notification target to send notification to customer's users:\n```json\n{\n \"name\": \"Users of Customer A\",\n \"configuration\": {\n \"type\": \"PLATFORM_USERS\",\n \"usersFilter\": {\n \"type\": \"CUSTOMER_USERS\",\n \"customerId\": \"32499a20-d785-11ed-a06c-21dd57dd88ca\"\n },\n \"description\": \"Users of Customer A\"\n }\n}\n```\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "95a4ade5-b7a7-49d1-8cb5-c6f8414c4ca1", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/target", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "target" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-95a4ade5-b7a7-49d1-8cb5-c6f8414c4ca1" } ], "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-050a99ef-55c5-4807-915e-5f5e9edaa824" } ], "id": "33abb67f-ca17-4ef7-a10b-d6f217c43d83", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-33abb67f-ca17-4ef7-a10b-d6f217c43d83" }, { "name": "targets", "item": [ { "name": "Get Notification Targets by Ids (getNotificationTargetsByIds)", "id": "46c11893-1a81-4337-8683-5c7b2d5d770b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/targets?pageSize=&page=&textSearch=&sortProperty=&sortOrder=¬ificationType=NEW_PLATFORM_VERSION&ids=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "targets" ], "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 target's 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": "" }, { "key": "notificationType", "value": "NEW_PLATFORM_VERSION" }, { "description": "(Required) Comma-separated list of uuids representing targets ids", "key": "ids", "value": "" }, { "description": "(Required) Comma-separated list of uuids representing targets ids", "key": "ids", "value": "" } ] }, "description": "Returns the list of notification targets found by provided ids.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "72fc299f-f0ee-4116-bb68-44299dd63b2f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/targets?pageSize=&page=&textSearch=&sortProperty=&sortOrder=¬ificationType=NEW_PLATFORM_VERSION&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "targets" ], "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 target's 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": "" }, { "key": "notificationType", "value": "NEW_PLATFORM_VERSION" }, { "description": "(Required) Comma-separated list of uuids representing targets ids", "key": "ids", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n {\n \"configuration\": {\n \"channelName\": \"\",\n \"type\": \"\",\n \"webhookUrl\": \"\",\n \"description\": \"\",\n \"useOldApi\": \"\",\n \"id\": {},\n \"title\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TARGET\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-72fc299f-f0ee-4116-bb68-44299dd63b2f" } ], "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-46c11893-1a81-4337-8683-5c7b2d5d770b" } ], "id": "25c247a7-d759-4b91-9acf-11c0d23dd184", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-25c247a7-d759-4b91-9acf-11c0d23dd184" } ], "id": "68b1834a-8025-4fdd-bf9c-81fe61aa0875", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-68b1834a-8025-4fdd-bf9c-81fe61aa0875" } ], "id": "48acdd36-7702-428f-bf46-5936403a3601", "createdAt": "2026-07-28T03:12:56.000Z", "updatedAt": "2026-07-28T03:12:56.000Z", "uid": "35240-48acdd36-7702-428f-bf46-5936403a3601" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }