{ "info": { "_postman_id": "b1711fef-7d7f-45ba-a10f-d31035f9342b", "name": "ThoughtSpot Public REST 10.1.0.cl 10.14.0.cl API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-b1711fef-7d7f-45ba-a10f-d31035f9342b" }, "item": [ { "name": "api", "item": [ { "name": "rest", "item": [ { "name": "2.0", "item": [ { "name": "system", "item": [ { "name": "preferences", "item": [ { "name": "communication-channels", "item": [ { "name": "configure", "item": [ { "name": "configure Communication Channel Preferences", "id": "4f323a89-cc4c-4ed8-b78c-d9f2ee317de8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/configure", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "configure" ] }, "description": "\nBeta Version: 10.14.0.cl or later\n\nConfigure communication channel preferences.\n- Use `cluster_preferences` to update the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to specify Org-specific preferences that override the defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "7086dff8-a12b-4e3d-afb0-97a12c33422d", "name": "Communication channel preferences successfully updated.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/configure", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "configure" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-7086dff8-a12b-4e3d-afb0-97a12c33422d" }, { "id": "6e8ac6dc-c6c9-496a-b2a0-2fbdfda75811", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/configure", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "configure" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-6e8ac6dc-c6c9-496a-b2a0-2fbdfda75811" }, { "id": "30072246-4e25-43c5-bbd0-6e1881a29b80", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/configure", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "configure" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-30072246-4e25-43c5-bbd0-6e1881a29b80" }, { "id": "5a19129e-39b4-4e56-a2db-d5a8b02f56dd", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/configure", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "configure" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-5a19129e-39b4-4e56-a2db-d5a8b02f56dd" }, { "id": "e7065709-3440-4d00-9cbd-361283748699", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"operation\": \"REPLACE\",\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"EMAIL\"\n ]\n }\n ],\n \"reset_events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/configure", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "configure" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-e7065709-3440-4d00-9cbd-361283748699" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-4f323a89-cc4c-4ed8-b78c-d9f2ee317de8" } ], "id": "e29c4767-5ebb-447b-890c-d4a1e36d9cbd", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-e29c4767-5ebb-447b-890c-d4a1e36d9cbd" }, { "name": "search", "item": [ { "name": "search Communication Channel Preferences", "id": "f3cdf808-2cfb-41b2-adc8-274b2344adbb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "search" ] }, "description": "\nBeta Version: 10.14.0.cl or later\n\nFetch communication channel preferences.\n- Use `cluster_preferences` to fetch the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to fetch any Org-specific preferences that override the defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "996a8feb-3ca0-4865-aa5b-33dbb9c7eccc", "name": "Communication channel preferences retrieved successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"cluster_preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"WEBHOOK\"\n ]\n }\n ],\n \"org_preferences\": [\n {\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"EMAIL\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"WEBHOOK\"\n ]\n }\n ]\n },\n {\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"preferences\": [\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"EMAIL\",\n \"WEBHOOK\"\n ]\n },\n {\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"channels\": [\n \"WEBHOOK\",\n \"WEBHOOK\"\n ]\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-996a8feb-3ca0-4865-aa5b-33dbb9c7eccc" }, { "id": "391b31dd-60ee-4a5c-8dcb-b70b473b811e", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-391b31dd-60ee-4a5c-8dcb-b70b473b811e" }, { "id": "ebb0e070-5f20-4a64-92f6-da144368c3bb", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-ebb0e070-5f20-4a64-92f6-da144368c3bb" }, { "id": "0697a756-d9e4-4ac7-a6a2-27ba6a14dd06", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-0697a756-d9e4-4ac7-a6a2-27ba6a14dd06" }, { "id": "dcbdd417-3b8e-493d-988b-ad7fea22c1be", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"cluster_preferences\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"org_preferences\": [\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n },\n {\n \"org_identifier\": \"\",\n \"event_types\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/preferences/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "preferences", "communication-channels", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-dcbdd417-3b8e-493d-988b-ad7fea22c1be" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-f3cdf808-2cfb-41b2-adc8-274b2344adbb" } ], "id": "4b6e3440-335f-4e20-a947-bf05f02051af", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-4b6e3440-335f-4e20-a947-bf05f02051af" } ], "id": "2eba3fe3-0786-4e2f-9817-2f08a0b3d94f", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-2eba3fe3-0786-4e2f-9817-2f08a0b3d94f" } ], "id": "32fd4c5d-9e9d-4c50-82c9-f39e26a92a84", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-32fd4c5d-9e9d-4c50-82c9-f39e26a92a84" } ], "id": "da74f63f-c671-46ae-956e-c450dd65ba03", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-da74f63f-c671-46ae-956e-c450dd65ba03" }, { "name": "template", "item": [ { "name": "variables", "item": [ { "name": "{identifier}", "item": [ { "name": "delete", "item": [ { "name": "delete Variable", "id": "a4bfa7a2-88bc-4fcb-99a2-b8ea763f6230", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "delete" ], "variable": [ { "id": "a754c947-3f79-41e8-a0b0-701f41f8e000", "key": "identifier", "value": "", "description": "(Required) Unique id or name of the variable" } ] }, "description": "\nDelete a variable
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/delete](/api/rest/2.0/template/variables/delete) instead.\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifier (ID or name)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable doesn't exist\n* The variable is being used by other objects \n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "9cad328d-10f3-40e7-a1b4-c1c993177a7c", "name": "Deleting the variable is successful.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "delete" ], "variable": [ { "key": "identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-9cad328d-10f3-40e7-a1b4-c1c993177a7c" }, { "id": "0e8962da-7615-4d32-a271-6c5684e5bc61", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "delete" ], "variable": [ { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-0e8962da-7615-4d32-a271-6c5684e5bc61" }, { "id": "9a2411ce-6a15-4c32-ad98-ddd653d609c8", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "delete" ], "variable": [ { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-9a2411ce-6a15-4c32-ad98-ddd653d609c8" }, { "id": "966ce8bf-ae9e-4265-9403-e1a705e48a75", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "delete" ], "variable": [ { "key": "identifier" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-966ce8bf-ae9e-4265-9403-e1a705e48a75" }, { "id": "67d5fb65-82c0-4100-a999-08a240b7e760", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "delete" ], "variable": [ { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-67d5fb65-82c0-4100-a999-08a240b7e760" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-a4bfa7a2-88bc-4fcb-99a2-b8ea763f6230" } ], "id": "82d45ed5-1892-4d42-ae56-bafbe0fa99f7", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-82d45ed5-1892-4d42-ae56-bafbe0fa99f7" } ], "id": "dc812459-3b88-4c24-ab71-3c683ce31022", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-dc812459-3b88-4c24-ab71-3c683ce31022" }, { "name": "update-values", "item": [ { "name": "update Variable Values", "id": "c92202d3-63c9-45d5-a28b-f2a3a2f0ef6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n },\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n }\n ],\n \"variable_value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "update-values" ] }, "description": "\nUpdate values for multiple variables
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/{identifier}/update-values](/api/rest/2.0/template/variables/%7Bidentifier%7D/update-values) instead.\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to variables\n* Replacing existing values\n* Deleting values from variables\n\nWhen updating variable values, you need to specify:\n* The variable identifiers\n* The values to add/replace/remove for each variable\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constrains for a given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "a1779ebb-89b1-47df-9287-8bfcb631a1f2", "name": "Variable values updated successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n },\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n }\n ],\n \"variable_value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "update-values" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-a1779ebb-89b1-47df-9287-8bfcb631a1f2" }, { "id": "3e4d6136-5572-4d53-8805-1ec707837c62", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n },\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n }\n ],\n \"variable_value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "update-values" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-3e4d6136-5572-4d53-8805-1ec707837c62" }, { "id": "1d2e1863-3b58-46fc-ad64-f5abf9e6267c", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n },\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n }\n ],\n \"variable_value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "update-values" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-1d2e1863-3b58-46fc-ad64-f5abf9e6267c" }, { "id": "b70f3753-257f-437c-a32a-d033f3ec933d", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n },\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n }\n ],\n \"variable_value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "update-values" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-b70f3753-257f-437c-a32a-d033f3ec933d" }, { "id": "af7e9ab8-c825-4bd2-b277-fbc3cec699a7", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n },\n {\n \"variable_identifier\": \"\",\n \"variable_values\": [\n \"\",\n \"\"\n ],\n \"operation\": \"ADD\"\n }\n ],\n \"variable_value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "update-values" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-af7e9ab8-c825-4bd2-b277-fbc3cec699a7" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-c92202d3-63c9-45d5-a28b-f2a3a2f0ef6c" } ], "id": "5cb4dc72-fd3c-4038-aa51-add37fb14f2e", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-5cb4dc72-fd3c-4038-aa51-add37fb14f2e" } ], "id": "7f1b608f-a89c-4920-bb6a-fd9c6c1f2c56", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-7f1b608f-a89c-4920-bb6a-fd9c6c1f2c56" } ], "id": "6d68fa0c-a602-4b55-b136-82319bb8a491", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-6d68fa0c-a602-4b55-b136-82319bb8a491" }, { "name": "webhooks", "item": [ { "name": "create", "item": [ { "name": "create Webhook Configuration", "id": "8b9bbd63-399f-46a6-8ce2-31c22e6e09d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"description\": \"\",\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "create" ] }, "description": "\n Version: 10.14.0.cl or later\n\nCreates a new webhook configuration to receive notifications for specified events. The webhook will be triggered when the configured events occur in the system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "ad65881f-179b-410d-bdf6-785d745920c5", "name": "Webhook configuration created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"description\": \"\",\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"creation_time_in_millis\": \"\",\n \"modification_time_in_millis\": \"\",\n \"description\": \"\",\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"last_modified_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"status\": \"DISABLED\"\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-ad65881f-179b-410d-bdf6-785d745920c5" }, { "id": "6dda775d-0576-4c35-ba6e-a8e88295e24e", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"description\": \"\",\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "create" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-6dda775d-0576-4c35-ba6e-a8e88295e24e" }, { "id": "8e32df75-e998-45fe-bf62-dede7735cab8", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"description\": \"\",\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "create" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-8e32df75-e998-45fe-bf62-dede7735cab8" }, { "id": "b16d63ef-2b61-4ec7-88b2-48829dc564f6", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"description\": \"\",\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "create" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-b16d63ef-2b61-4ec7-88b2-48829dc564f6" }, { "id": "179cf364-e90d-4435-83b1-808dfadd286a", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"description\": \"\",\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-179cf364-e90d-4435-83b1-808dfadd286a" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-8b9bbd63-399f-46a6-8ce2-31c22e6e09d4" } ], "id": "5b7b8f10-48b4-44e8-b88f-0b3e55621079", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-5b7b8f10-48b4-44e8-b88f-0b3e55621079" }, { "name": "delete", "item": [ { "name": "delete Webhook Configurations", "id": "77ffe4bc-7689-4506-bc1b-37c551074999", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"webhook_identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "delete" ] }, "description": "\n Version: 10.14.0.cl or later\n\nDeletes one or more webhook configurations by their unique id or name. Returns status of each deletion operation, including successfully deleted webhooks and any failures with error details.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "3562f6d0-9646-447c-9d66-5c26ce6ff7a6", "name": "Webhook configurations deleted successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"webhook_identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "delete" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deleted_count\": \"\",\n \"failed_count\": \"\",\n \"deleted_webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"creation_time_in_millis\": \"\",\n \"modification_time_in_millis\": \"\",\n \"description\": \"\",\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"last_modified_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"status\": \"ENABLED\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"creation_time_in_millis\": \"\",\n \"modification_time_in_millis\": \"\",\n \"description\": \"\",\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"last_modified_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"status\": \"DISABLED\"\n }\n ],\n \"failed_webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"error\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"error\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-3562f6d0-9646-447c-9d66-5c26ce6ff7a6" }, { "id": "565c81e0-dabb-4197-985c-cc8b1279bcc3", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"webhook_identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "delete" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-565c81e0-dabb-4197-985c-cc8b1279bcc3" }, { "id": "a7e04503-716f-4b80-824f-04c9f475b7b8", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"webhook_identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "delete" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-a7e04503-716f-4b80-824f-04c9f475b7b8" }, { "id": "05ffb983-04b6-41ee-ad5e-9050cdb6ec0f", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"webhook_identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "delete" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-05ffb983-04b6-41ee-ad5e-9050cdb6ec0f" }, { "id": "ad4b6f24-06fc-463c-8d1c-2ceb9f01813e", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"webhook_identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "delete" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-ad4b6f24-06fc-463c-8d1c-2ceb9f01813e" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-77ffe4bc-7689-4506-bc1b-37c551074999" } ], "id": "b89d99b0-028b-4d69-a046-307689aae242", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-b89d99b0-028b-4d69-a046-307689aae242" }, { "name": "search", "item": [ { "name": "search Webhook Configurations", "id": "c5f7cc0f-7006-4859-b0e7-e7c24ed49360", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"org_identifier\": \"\",\n \"webhook_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"record_offset\": 0,\n \"record_size\": 50,\n \"sort_options\": {\n \"field_name\": \"CREATED\",\n \"order\": \"DESC\"\n },\n \"status\": \"ENABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "search" ] }, "description": "\n Version: 10.14.0.cl or later\n\nSearches for webhook configurations based on various criteria such as Org, webhook identifier, event type, with support for pagination and sorting. Returns matching webhook configurations with their complete details.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "3a92b1e8-7ed3-403b-8024-877f155c59d8", "name": "Webhook configurations retrieved successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"org_identifier\": \"\",\n \"webhook_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"record_offset\": 0,\n \"record_size\": 50,\n \"sort_options\": {\n \"field_name\": \"CREATED\",\n \"order\": \"DESC\"\n },\n \"status\": \"ENABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"creation_time_in_millis\": \"\",\n \"modification_time_in_millis\": \"\",\n \"description\": \"\",\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"last_modified_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"status\": \"DISABLED\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"creation_time_in_millis\": \"\",\n \"modification_time_in_millis\": \"\",\n \"description\": \"\",\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"url_params\": {},\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"last_modified_by\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"AWS_S3\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"status\": \"ENABLED\"\n }\n ],\n \"pagination\": {\n \"record_offset\": \"\",\n \"record_size\": \"\",\n \"total_count\": \"\",\n \"has_more\": \"\"\n }\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-3a92b1e8-7ed3-403b-8024-877f155c59d8" }, { "id": "6440a1d7-e2b3-4f04-9c1d-160883537280", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"org_identifier\": \"\",\n \"webhook_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"record_offset\": 0,\n \"record_size\": 50,\n \"sort_options\": {\n \"field_name\": \"CREATED\",\n \"order\": \"DESC\"\n },\n \"status\": \"ENABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-6440a1d7-e2b3-4f04-9c1d-160883537280" }, { "id": "3e7bc1b7-ad03-4e0c-aca5-9b4a43afb5a5", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"org_identifier\": \"\",\n \"webhook_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"record_offset\": 0,\n \"record_size\": 50,\n \"sort_options\": {\n \"field_name\": \"CREATED\",\n \"order\": \"DESC\"\n },\n \"status\": \"ENABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-3e7bc1b7-ad03-4e0c-aca5-9b4a43afb5a5" }, { "id": "555c646c-700a-4ab5-bd18-3e4c4636aa11", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"org_identifier\": \"\",\n \"webhook_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"record_offset\": 0,\n \"record_size\": 50,\n \"sort_options\": {\n \"field_name\": \"CREATED\",\n \"order\": \"DESC\"\n },\n \"status\": \"ENABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-555c646c-700a-4ab5-bd18-3e4c4636aa11" }, { "id": "abbd2714-e277-4a08-aded-accbe235aa37", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"org_identifier\": \"\",\n \"webhook_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"record_offset\": 0,\n \"record_size\": 50,\n \"sort_options\": {\n \"field_name\": \"CREATED\",\n \"order\": \"DESC\"\n },\n \"status\": \"ENABLED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-abbd2714-e277-4a08-aded-accbe235aa37" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-c5f7cc0f-7006-4859-b0e7-e7c24ed49360" } ], "id": "4eb4c776-ce30-488a-949d-926b15af3643", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-4eb4c776-ce30-488a-949d-926b15af3643" }, { "name": "{webhook_identifier}", "item": [ { "name": "update", "item": [ { "name": "update Webhook Configuration", "id": "8c02fcc7-e84f-4e8c-87f8-7c4ef5855b43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"url_params\": {},\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\",\n \"reset_options\": [\n \"STORAGE_DESTINATION\",\n \"AUTHENTICATION\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/:webhook_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", ":webhook_identifier", "update" ], "variable": [ { "id": "cd75841f-409a-43ce-916f-b5a4dbae04b4", "key": "webhook_identifier", "value": "", "description": "(Required) Unique ID or name of the webhook configuration." } ] }, "description": "\n Version: 10.14.0.cl or later\n\nUpdates an existing webhook configuration by its unique id or name. Only the provided fields will be updated.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "59409c55-21ea-4c6c-82f4-e520ec7c73ac", "name": "Webhook configuration updated successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"url_params\": {},\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\",\n \"reset_options\": [\n \"STORAGE_DESTINATION\",\n \"AUTHENTICATION\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/:webhook_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", ":webhook_identifier", "update" ], "variable": [ { "key": "webhook_identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-59409c55-21ea-4c6c-82f4-e520ec7c73ac" }, { "id": "69181468-f020-4a9c-94d6-c1bfb34525b0", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"url_params\": {},\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\",\n \"reset_options\": [\n \"STORAGE_DESTINATION\",\n \"AUTHENTICATION\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/:webhook_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", ":webhook_identifier", "update" ], "variable": [ { "key": "webhook_identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-69181468-f020-4a9c-94d6-c1bfb34525b0" }, { "id": "f9dbd527-1a87-428d-b972-edba69167527", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"url_params\": {},\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\",\n \"reset_options\": [\n \"STORAGE_DESTINATION\",\n \"AUTHENTICATION\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/:webhook_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", ":webhook_identifier", "update" ], "variable": [ { "key": "webhook_identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-f9dbd527-1a87-428d-b972-edba69167527" }, { "id": "794d98cf-4a0b-4708-ab10-af99a2d9a652", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"url_params\": {},\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\",\n \"reset_options\": [\n \"STORAGE_DESTINATION\",\n \"AUTHENTICATION\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/:webhook_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", ":webhook_identifier", "update" ], "variable": [ { "key": "webhook_identifier" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-794d98cf-4a0b-4708-ab10-af99a2d9a652" }, { "id": "0aeea277-016e-4dfb-ad4a-71160d633b40", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"url_params\": {},\n \"events\": [\n \"LIVEBOARD_SCHEDULE\",\n \"LIVEBOARD_SCHEDULE\"\n ],\n \"authentication\": {\n \"API_KEY\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"BASIC_AUTH\": {\n \"username\": \"\",\n \"password\": \"\"\n },\n \"BEARER_TOKEN\": \"\",\n \"OAUTH2\": {\n \"authorization_url\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n },\n \"signature_verification\": {\n \"type\": \"HMAC_SHA256\",\n \"header\": \"\",\n \"algorithm\": \"SHA256\",\n \"secret\": \"\"\n },\n \"storage_destination\": {\n \"storage_type\": \"GCP_GCS\",\n \"storage_config\": {\n \"aws_s3_config\": {\n \"bucket_name\": \"\",\n \"region\": \"\",\n \"role_arn\": \"\",\n \"external_id\": \"\",\n \"path_prefix\": \"\"\n },\n \"gcp_gcs_config\": {\n \"bucket_name\": \"\",\n \"service_account_email\": \"\",\n \"path_prefix\": \"\"\n }\n }\n },\n \"additional_headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"status\": \"DISABLED\",\n \"reset_options\": [\n \"STORAGE_DESTINATION\",\n \"AUTHENTICATION\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/webhooks/:webhook_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "webhooks", ":webhook_identifier", "update" ], "variable": [ { "key": "webhook_identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-0aeea277-016e-4dfb-ad4a-71160d633b40" } ], "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-8c02fcc7-e84f-4e8c-87f8-7c4ef5855b43" } ], "id": "38be5f38-2b1c-41fb-8377-32a7ffd22607", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-38be5f38-2b1c-41fb-8377-32a7ffd22607" } ], "id": "9f50df65-334f-4cc2-91ec-c32d3e65082d", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-9f50df65-334f-4cc2-91ec-c32d3e65082d" } ], "id": "66cc91a7-7dbf-45be-acf1-673115fc85af", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-66cc91a7-7dbf-45be-acf1-673115fc85af" } ], "id": "be936fad-f2dd-4314-a38f-61a9c67023d1", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-be936fad-f2dd-4314-a38f-61a9c67023d1" } ], "id": "b74a1ab8-8c3b-4eb7-ad0f-73530e871115", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-b74a1ab8-8c3b-4eb7-ad0f-73530e871115" } ], "id": "952c3815-6d9d-40c2-8871-9a37fedb92ef", "createdAt": "2026-07-28T03:13:42.000Z", "updatedAt": "2026-07-28T03:13:42.000Z", "uid": "35240-952c3815-6d9d-40c2-8871-9a37fedb92ef" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "base-url", "value": "https://localhost:443" }, { "key": "baseUrl", "value": "{{base-url}}" } ] }