{ "info": { "_postman_id": "6bcd55bd-a0ab-41bb-ae1c-89c04cb0bc4e", "name": "CircleCI REST API v1 Artifact Webhook API", "description": "The CircleCI REST API v1 is the legacy API that provides access to build information, project details, and user data. While still available, CircleCI recommends migrating to the v2 API for newer features and improved functionality. The v1 API supports operations for retrieving build details, triggering builds, managing SSH keys, and accessing test metadata. Authentication is handled through API tokens passed as query parameters or HTTP headers.\n\nContact Support:\n Name: CircleCI Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:21:56.000Z", "updatedAt": "2026-07-28T01:21:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-6bcd55bd-a0ab-41bb-ae1c-89c04cb0bc4e" }, "item": [ { "name": "webhook", "item": [ { "name": "{webhook-id}", "item": [ { "name": "Get a webhook by ID", "id": "b0a7236c-341d-4c68-b75f-eccca9cb5743", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "id": "18b758c4-24f3-4fb8-be27-25939de62502", "key": "webhook-id", "value": "", "description": "(Required) The unique identifier of the webhook" } ] }, "description": "Returns a webhook by its unique identifier." }, "response": [ { "id": "0bf076bb-0082-4936-abbb-c2802af6fe81", "name": "Successfully retrieved webhook", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\",\n \"created-at\": \"\",\n \"updated-at\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-0bf076bb-0082-4936-abbb-c2802af6fe81" }, { "id": "b16e8cd1-ec50-4c41-a509-9b5ddd06e168", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-b16e8cd1-ec50-4c41-a509-9b5ddd06e168" }, { "id": "e4cb46b0-9837-4ba8-8659-c2ccd3f6f103", "name": "Webhook not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-e4cb46b0-9837-4ba8-8659-c2ccd3f6f103" } ], "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-b0a7236c-341d-4c68-b75f-eccca9cb5743" }, { "name": "Update a webhook", "id": "488fac3c-39b3-4d0d-918e-5cffec678dc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "id": "db6a087e-9235-4056-b3c4-772fb0a0919e", "key": "webhook-id", "value": "", "description": "(Required) The unique identifier of the webhook" } ] }, "description": "Updates an existing webhook with the provided parameters." }, "response": [ { "id": "3b9014de-2972-48bd-b60c-98293fe696e8", "name": "Webhook updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\",\n \"created-at\": \"\",\n \"updated-at\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-3b9014de-2972-48bd-b60c-98293fe696e8" }, { "id": "691c1f38-cc49-494f-a02b-b099d1cd3311", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-691c1f38-cc49-494f-a02b-b099d1cd3311" } ], "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-488fac3c-39b3-4d0d-918e-5cffec678dc4" }, { "name": "Delete a webhook", "id": "0b5c851e-6a4c-4f3e-a6ca-1326d7c61f5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "id": "19bf57ee-485e-49d6-abeb-b660a103c194", "key": "webhook-id", "value": "", "description": "(Required) The unique identifier of the webhook" } ] }, "description": "Deletes a webhook by its unique identifier." }, "response": [ { "id": "3a97c9f5-1bc5-4497-9c4f-e4967b2a9799", "name": "Webhook deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-3a97c9f5-1bc5-4497-9c4f-e4967b2a9799" }, { "id": "f5270357-9f7e-4e37-bd60-fd8560d29ff1", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook/:webhook-id", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":webhook-id" ], "variable": [ { "key": "webhook-id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-f5270357-9f7e-4e37-bd60-fd8560d29ff1" } ], "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-0b5c851e-6a4c-4f3e-a6ca-1326d7c61f5a" } ], "id": "eb147621-0a99-4c10-9321-86c853bba7f3", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-eb147621-0a99-4c10-9321-86c853bba7f3" }, { "name": "List webhooks", "id": "c1bc9667-1bbf-4a81-9848-63c0d286f0af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhook?scope-id=&scope-type=project", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "description": "(Required) The ID of the scope (project ID)", "key": "scope-id", "value": "" }, { "description": "(Required) The type of scope", "key": "scope-type", "value": "project" } ] }, "description": "Returns a list of outbound webhooks for the specified scope." }, "response": [ { "id": "6f05f456-7a6a-42c7-a532-e1c55b0103a1", "name": "Successfully retrieved webhooks", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook?scope-id=&scope-type=project", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "description": "(Required) The ID of the scope (project ID)", "key": "scope-id", "value": "" }, { "description": "(Required) The type of scope", "key": "scope-type", "value": "project" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"job-completed\",\n \"job-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\",\n \"created-at\": \"\",\n \"updated-at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"workflow-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\",\n \"created-at\": \"\",\n \"updated-at\": \"\"\n }\n ],\n \"next_page_token\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-6f05f456-7a6a-42c7-a532-e1c55b0103a1" }, { "id": "08772574-a7b7-43f0-9bc4-c004bd026bff", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook?scope-id=&scope-type=project", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "description": "(Required) The ID of the scope (project ID)", "key": "scope-id", "value": "" }, { "description": "(Required) The type of scope", "key": "scope-type", "value": "project" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-08772574-a7b7-43f0-9bc4-c004bd026bff" } ], "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-c1bc9667-1bbf-4a81-9848-63c0d286f0af" }, { "name": "Create a webhook", "id": "ffbb908c-c6c7-41e3-a2e2-f44a4d010743", "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 \"workflow-completed\",\n \"workflow-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"project\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ] }, "description": "Creates a new outbound webhook for the specified scope." }, "response": [ { "id": "df8f3c58-bfc9-4740-a08a-a3763ec2b9b6", "name": "Webhook 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: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"workflow-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"project\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"job-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\",\n \"created-at\": \"\",\n \"updated-at\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-df8f3c58-bfc9-4740-a08a-a3763ec2b9b6" }, { "id": "aea23e53-4517-4e84-b8b1-bc55c001a928", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"workflow-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"project\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-aea23e53-4517-4e84-b8b1-bc55c001a928" }, { "id": "17b55a74-25a7-4a29-87e2-6341dda06dce", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Circle-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"workflow-completed\",\n \"workflow-completed\"\n ],\n \"scope\": {\n \"id\": \"\",\n \"type\": \"project\"\n },\n \"signing-secret\": \"\",\n \"verify-tls\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-17b55a74-25a7-4a29-87e2-6341dda06dce" } ], "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-ffbb908c-c6c7-41e3-a2e2-f44a4d010743" } ], "id": "9be9b4cf-c4d8-42fe-bde2-ba6dd22c7f8f", "createdAt": "2026-07-28T01:21:57.000Z", "updatedAt": "2026-07-28T01:21:57.000Z", "uid": "35240-9be9b4cf-c4d8-42fe-bde2-ba6dd22c7f8f" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Circle-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://circleci.com/api/v1.1" } ] }