{"info":{"_postman_id":"bed70275-410b-42d6-a4c3-55ecd21a16cb","name":"BigCommerce  Webhook API","description":"<html><head></head><body><p>This API is used to create and delete different webhooks required for caching in <strong>Front-Commerce</strong> of the <strong>BigCommerce integration</strong></p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16678499","collectionId":"bed70275-410b-42d6-a4c3-55ecd21a16cb","publishedId":"UzQys4QZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"b8124a"},"publishDate":"2022-07-20T14:25:42.000Z"},"item":[{"name":"CREATE","item":[{"name":"Category","id":"00494384-1557-4e6f-b43e-06e7dbdd4980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Token","value":"{{ACCESS_TOKEN}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"scope\": \"store/category/*\",\r\n    \"destination\": \"{{HOST}}/bigcommerce/webhook\",\r\n    \"is_active\": true,\r\n    \"headers\": {\r\n        \"x-bigcommerce-webhook-secret\": \"{{WEBHOOK_SECRET}}\"\r\n    }\r\n}"},"url":"https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks","description":"<p>This webhook will trigger whenever something changes in the <strong>category</strong> scope.</p>\n","urlObject":{"protocol":"https","path":["stores","{{STORE_HASH}}","v3","hooks"],"host":["api","bigcommerce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"00494384-1557-4e6f-b43e-06e7dbdd4980"},{"name":"Product","id":"179dba81-4b13-4f17-8abe-47974b854ba8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Token","value":"{{ACCESS_TOKEN}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"scope\": \"store/product/*\",\r\n    \"destination\": \"{{HOST}}/bigcommerce/webhook\",\r\n    \"is_active\": true,\r\n    \"headers\": {\r\n        \"x-bigcommerce-webhook-secret\": \"{{WEBHOOK_SECRET}}\"\r\n    }\r\n}"},"url":"https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks","description":"<p>This webhook will trigger whenever something changes in the <strong>product</strong> scope</p>\n","urlObject":{"protocol":"https","path":["stores","{{STORE_HASH}}","v3","hooks"],"host":["api","bigcommerce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"179dba81-4b13-4f17-8abe-47974b854ba8"},{"name":"SKU","id":"a352c808-7428-4fed-8a2f-385e90826371","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Token","value":"{{ACCESS_TOKEN}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"scope\": \"store/sku/*\",\r\n    \"destination\": \"{{HOST}}/bigcommerce/webhook\",\r\n    \"is_active\": true,\r\n    \"headers\": {\r\n        \"x-bigcommerce-webhook-secret\": \"{{WEBHOOK_SECRET}}\"\r\n    }\r\n}"},"url":"https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks","description":"<p>This webhook will trigger whenever something changes in the <strong>sku</strong> scope, this includes product variants.</p>\n","urlObject":{"protocol":"https","path":["stores","{{STORE_HASH}}","v3","hooks"],"host":["api","bigcommerce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a352c808-7428-4fed-8a2f-385e90826371"}],"id":"35d0615d-420e-4cf1-aeb6-2c5c1842e8b3","description":"<p>The list of required webhooks which needs to be created for cache invalidation</p>\n","_postman_id":"35d0615d-420e-4cf1-aeb6-2c5c1842e8b3"},{"name":"ALL WEBHOOKS","id":"a25ed1dc-1d17-42f0-ab12-b754c21a0d75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Token","value":"{{ACCESS_TOKEN}}","type":"text"}],"url":"https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks","description":"<p>This API is used when you need to delete a webhook, first, you can retrieve all the webhooks, afterwards, you can use the delete API using the specific webhook id.</p>\n","urlObject":{"protocol":"https","path":["stores","{{STORE_HASH}}","v3","hooks"],"host":["api","bigcommerce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a25ed1dc-1d17-42f0-ab12-b754c21a0d75"},{"name":"WEBHOOK","id":"900a64da-1dee-4f32-864b-a91eb7fa0f1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Auth-Token","value":"{{ACCESS_TOKEN}}","type":"text"}],"url":"https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks/24420627","urlObject":{"protocol":"https","path":["stores","{{STORE_HASH}}","v3","hooks","24420627"],"host":["api","bigcommerce","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"900a64da-1dee-4f32-864b-a91eb7fa0f1f"}],"event":[{"listen":"prerequest","script":{"id":"16efe5f8-d7de-4061-9467-b5faeda3b61a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"37310f04-956e-4d0f-914c-2c08bee87c83","type":"text/javascript","exec":[""]}}],"variable":[{"key":"WEBHOOK_ID","value":"{{WEBHOOK_ID}}"}]}