{ "info": { "_postman_id": "f3ada4dd-f055-4003-aed0-5674a560bac4", "name": "Configuration API", "description": "The configuration API allows to manage account-wide and subaccount configurations such as the webhooks used for SMS and Chat-Apps inbound messages, delivery and read receipts and various events.\n\nContact Support:\n Name: 8x8 Inc\n Email: support@8x8.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:28:32.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "lastUpdatedBy": "35240", "uid": "35240-f3ada4dd-f055-4003-aed0-5674a560bac4" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "webhooks", "item": [ { "name": "Get all Webhooks for Account", "id": "47151316-6155-4451-8244-3c70906d950d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "1bd23514-ff18-43e9-8190-b8fc3a0e7655", "key": "accountId", "value": "B58780B3-B92bD190-d517-4d3BC3F6cFAb", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Sending a GET request on this endpoint allows to **retrieve a list of all the webhooks or a specific webhook configured for an account**." }, "response": [ { "id": "3349c6ce-a9b7-4beb-8788-7b8aa781ae1b", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"EV\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n }\n]", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-3349c6ce-a9b7-4beb-8788-7b8aa781ae1b" }, { "id": "4c7edca7-928b-40a2-a6a5-6b53f8bbd3af", "name": "Bad request error response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-4c7edca7-928b-40a2-a6a5-6b53f8bbd3af" }, { "id": "9edb4a1f-0be7-4de6-9dc5-d82e1424eb83", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-9edb4a1f-0be7-4de6-9dc5-d82e1424eb83" }, { "id": "8e60ee52-9451-4864-8fcb-e6ded0c4b726", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-8e60ee52-9451-4864-8fcb-e6ded0c4b726" } ], "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-47151316-6155-4451-8244-3c70906d950d" }, { "name": "Create or Replace webhooks", "id": "c31b8cdf-49a3-43b6-a421-bd3ca1cb22d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"EV\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "2c1007cc-18cf-4fec-92f7-2f2e9eee549a", "key": "accountId", "value": "B58780B3-B92bD190-d517-4d3BC3F6cFAb", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Sending a POST request on this endpoint allows to **add a new webhook for an account or modify the configuration of an existing one** . \n\nWebhooks can be given an account-wide and/or a type-wide scope using the \\* character \n\nFor example: if a webhook is created with subAccount=\\* , this webhook will receive events across all the subaccounts of an account. \nFollowing the same logic: if a webhook is created with type=\\* , this webhook will receive events of any type (delivery receipts, inbound messages, events)" }, "response": [ { "id": "4151ef79-1dcc-41a9-9f5c-95ccf03d24d9", "name": "The webhook was created or 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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"EV\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-4151ef79-1dcc-41a9-9f5c-95ccf03d24d9" }, { "id": "49c0e6c6-26f0-4429-8413-a6b3bec8855a", "name": "Bad request error response", "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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"EV\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-49c0e6c6-26f0-4429-8413-a6b3bec8855a" }, { "id": "6dbdddd1-b28b-4d9e-b7ef-bc132bbbbe6d", "name": "Request was not authenticated response", "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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"EV\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-6dbdddd1-b28b-4d9e-b7ef-bc132bbbbe6d" }, { "id": "863571f7-de79-41b4-a6de-4fa0cc35fbaa", "name": "Internal server 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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"EV\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-863571f7-de79-41b4-a6de-4fa0cc35fbaa" } ], "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-c31b8cdf-49a3-43b6-a421-bd3ca1cb22d3" }, { "name": "Delete webhooks", "id": "47be0d98-2d8f-4c16-9f69-21767c8fda0f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "79ea0373-6960-4bc5-9485-cf1dad6e64e4", "key": "accountId", "value": "B58780B3-B92bD190-d517-4d3BC3F6cFAb", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Sending a DELETE request on this endpoint allows to **remove a configured webhook for an account or a subaccount** ." }, "response": [ { "id": "66e233f4-e8d8-46fe-abac-942c08b97f32", "name": "The webhook was deleted successfully", "originalRequest": { "method": "DELETE", "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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-66e233f4-e8d8-46fe-abac-942c08b97f32" }, { "id": "3a685f1d-6b90-4cdf-bf4c-37897d3543d0", "name": "Bad request error response", "originalRequest": { "method": "DELETE", "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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-3a685f1d-6b90-4cdf-bf4c-37897d3543d0" }, { "id": "d31a2cd4-ea03-404c-8b85-640854433fa2", "name": "Request was not authenticated response", "originalRequest": { "method": "DELETE", "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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-d31a2cd4-ea03-404c-8b85-640854433fa2" }, { "id": "b306986a-b80b-4e27-b0ff-a6b7a933b194", "name": "Internal server error", "originalRequest": { "method": "DELETE", "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 {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"DR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-b306986a-b80b-4e27-b0ff-a6b7a933b194" } ], "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-47be0d98-2d8f-4c16-9f69-21767c8fda0f" } ], "id": "69647128-18f8-449c-b8f1-246c2bb60213", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-69647128-18f8-449c-b8f1-246c2bb60213" } ], "id": "542bb9c5-e874-41e8-aba7-bb2d5af77f47", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-542bb9c5-e874-41e8-aba7-bb2d5af77f47" } ], "id": "5603d266-4204-46da-b9a9-0c457fe6a0e9", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-5603d266-4204-46da-b9a9-0c457fe6a0e9" } ], "id": "c3a6aa0b-8992-4d1b-9e2d-b1872feb1f3d", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-c3a6aa0b-8992-4d1b-9e2d-b1872feb1f3d" } ], "id": "a37eb6c0-a82b-4472-8cc0-15856100ea46", "createdAt": "2026-07-28T00:28:33.000Z", "updatedAt": "2026-07-28T00:28:33.000Z", "uid": "35240-a37eb6c0-a82b-4472-8cc0-15856100ea46" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://sms.8x8.com" } ] }