{"info":{"_postman_id":"f4bd6418-5469-42aa-a4e3-ab7fa693011d","name":"SyncSketch API","description":"<html><head></head><body><h1 id=\"syncsketchcom\">syncsketch.com</h1>\n<h2 id=\"public-api-documentation\">Public API documentation</h2>\n<h3 id=\"api-access-is-only-available-for-enterprise-accounts\">API access is only available for enterprise accounts.</h3>\n<p>If you are using python, you should also check out our python api library (<a href=\"https://github.com/syncsketch/python-api\">https://github.com/syncsketch/python-api</a>).</p>\n<p>For help on how to generate and access your api credentials, visit this support article: <a href=\"https://support.syncsketch.com/hc/en-us/articles/12832489342733-API-Script-Users\">https://support.syncsketch.com/hc/en-us/articles/12832489342733-API-Script-Users</a></p>\n<p>If you need help, please email <a href=\"mailto:support@syncsketch.com\">support@syncsketch.com</a></p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"syncsketch.com","slug":"syncsketchcom"}],"owner":"4817811","collectionId":"f4bd6418-5469-42aa-a4e3-ab7fa693011d","publishedId":"TVmLAxLM","public":true,"customColor":{"top-bar":"21272C","right-sidebar":"344048","highlight":"028667"},"publishDate":"2021-01-22T04:34:35.000Z"},"item":[{"name":"Account","item":[{"name":"Get Account","id":"01b42954-51b9-4f6e-94b4-343c5e1ee73d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v2/account/{{account_id}}/?fields=id,name,description","description":"<p>Get account information</p>\n","urlObject":{"protocol":"https","path":["api","v2","account","{{account_id}}",""],"host":["syncsketch","com"],"query":[{"description":{"content":"<p>Fields you want returned - optional</p>\n","type":"text/plain"},"key":"fields","value":"id,name,description"}],"variable":[]}},"response":[],"_postman_id":"01b42954-51b9-4f6e-94b4-343c5e1ee73d"},{"name":"Get All Project Users for Account","id":"b578c410-e3a9-434c-b6c5-7ccf6034b0b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v2/account/{{account_id}}/list_all_project_connections/?limit={{limit}}&offset={{offset}}","description":"<p>Get all users in projects in the workspace.</p>\n","urlObject":{"protocol":"https","path":["api","v2","account","{{account_id}}","list_all_project_connections",""],"host":["syncsketch","com"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[],"_postman_id":"b578c410-e3a9-434c-b6c5-7ccf6034b0b1"},{"name":"Update Account","id":"50330d8c-2ca8-4eb2-96a0-1a92b6f88fa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"Brady's test account\"\n}","options":{"raw":{"language":"json"}}},"url":"https://syncsketch.com/api/v1/account/{{account_id}}/","urlObject":{"protocol":"https","path":["api","v1","account","{{account_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"50330d8c-2ca8-4eb2-96a0-1a92b6f88fa0"}],"id":"aa3afdea-f91d-4286-be16-8ef4cc409cfa","_postman_id":"aa3afdea-f91d-4286-be16-8ef4cc409cfa","description":""},{"name":"Projects","item":[{"name":"Create Project","id":"575c242b-6ece-44dc-bc3d-338493f25793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"New API Project\",\n    \"description\": \"Project description\",\n    \"account_id\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://syncsketch.com/api/v1/project/","description":"<p>Add a new project to your workspace</p>\n","urlObject":{"protocol":"https","path":["api","v1","project",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"575c242b-6ece-44dc-bc3d-338493f25793"},{"name":"Duplicate Project","id":"30ff8a01-2fd0-4e27-b219-e716f37b13bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"New project name\",\n    \"users\": true,\n    \"settings\": false,\n    \"reviews\": false\n}"},"url":"https://syncsketch.com/api/v2/project/{{project_id}}/duplicate/","description":"<p>Duplicate a project.</p>\n<ul>\n<li>params:</li>\n<li>users: true/false<ul>\n<li>Whether the new project should contain the same users.</li>\n</ul>\n</li>\n<li>settings: true/false<ul>\n<li>Whether the settings should be copied to the new project.</li>\n</ul>\n</li>\n<li>reviews: true/false<ul>\n<li>Whether to copy the reviews into the new project.    ** The media/items will NOT be copied into the copied reviews.  This is only to scaffold the reviews.</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","v2","project","{{project_id}}","duplicate",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"30ff8a01-2fd0-4e27-b219-e716f37b13bc"},{"name":"Get Projects","id":"573cca3d-25e2-41c6-9276-870d15d247ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v1/project/?active=1","urlObject":{"protocol":"https","path":["api","v1","project",""],"host":["syncsketch","com"],"query":[{"disabled":true,"description":{"content":"<p>fields you want returned - optional (may still include some other fields)</p>\n","type":"text/plain"},"key":"fields","value":"id,name,description"},{"description":{"content":"<p>Only active (not deleted) projects</p>\n","type":"text/plain"},"key":"active","value":"1"},{"disabled":true,"key":"is_archived","value":"0"},{"disabled":true,"description":{"content":"<p>Include project tags</p>\n","type":"text/plain"},"key":"include_tags","value":"1"},{"disabled":true,"key":"name","value":"projectName"}],"variable":[]}},"response":[],"_postman_id":"573cca3d-25e2-41c6-9276-870d15d247ae"},{"name":"Get Project by ID","id":"caae067b-43f1-4385-83f1-24997f07ede8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"url":"https://syncsketch.com/api/v1/project/{{project_id}}/","description":"<p>Fetch a project directly by passing the ID in the url.</p>\n","urlObject":{"protocol":"https","path":["api","v1","project","{{project_id}}",""],"host":["syncsketch","com"],"query":[{"disabled":true,"description":{"content":"<p>fields you want returned - optional</p>\n","type":"text/plain"},"key":"fields","value":"id,name"}],"variable":[]}},"response":[],"_postman_id":"caae067b-43f1-4385-83f1-24997f07ede8"},{"name":"Get Project Storage Usage","id":"f1703d60-b7d6-4be7-bdc4-a818f170467d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"url":"https://syncsketch.com/api/v2/project/{{project_id}}/storage/","description":"<p>get a project's storage usage by passing the ID in the url.  Response is usage in bytes.</p>\n","urlObject":{"protocol":"https","path":["api","v2","project","{{project_id}}","storage",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1703d60-b7d6-4be7-bdc4-a818f170467d"},{"name":"Get Active Projects","id":"8a69f35e-f6de-4ffb-8309-7411c2c58573","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"url":"https://syncsketch.com/api/v1/project/?active=1&is_archived=0&account__active=1","description":"<p>The same request as \"Get Projects\" but with parameters to only get projects that are active, not archived, and in active accounts.</p>\n<p>You may also search by name by including the parameter \"name\"=\"some name\"</p>\n","urlObject":{"protocol":"https","path":["api","v1","project",""],"host":["syncsketch","com"],"query":[{"key":"active","value":"1"},{"key":"is_archived","value":"0"},{"description":{"content":"<p>In active accounts</p>\n","type":"text/plain"},"key":"account__active","value":"1"}],"variable":[]}},"response":[],"_postman_id":"8a69f35e-f6de-4ffb-8309-7411c2c58573"},{"name":"Update Project","id":"6261fa40-2416-491f-afa1-01d11758e55f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"New project name\"\n}"},"url":"https://syncsketch.com/api/v1/project/{{project_id}}/","urlObject":{"protocol":"https","path":["api","v1","project","{{project_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6261fa40-2416-491f-afa1-01d11758e55f"},{"name":"Archive Project","id":"a5962aaa-5abf-4dec-8e31-539ceef72d52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"is_archived\": 1\n}"},"url":"https://syncsketch.com/api/v1/project/{{project_id}}/","urlObject":{"protocol":"https","path":["api","v1","project","{{project_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5962aaa-5abf-4dec-8e31-539ceef72d52"},{"name":"Unarchive Project","id":"a220093b-35bf-4c62-93a1-060eb356de74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"is_archived\": 0\n}"},"url":"https://syncsketch.com/api/v1/project/{{project_id}}/","urlObject":{"protocol":"https","path":["api","v1","project","{{project_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a220093b-35bf-4c62-93a1-060eb356de74"},{"name":"Delete Project","id":"e291efe5-7403-46dd-ba5e-4aee0f4f57e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"active\": 0\n}"},"url":"https://syncsketch.com/api/v1/project/{{project_id}}/","description":"<p>We currently soft delete resources and our system fully deletes them after 30 days.</p>\n<p>Soft deleted projects do not count towards your storage usage.</p>\n","urlObject":{"protocol":"https","path":["api","v1","project","{{project_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e291efe5-7403-46dd-ba5e-4aee0f4f57e7"}],"id":"874389a5-c9e2-4a0c-9d27-e8f738c43e7b","_postman_id":"874389a5-c9e2-4a0c-9d27-e8f738c43e7b","description":""},{"name":"Reviews","item":[{"name":"Review Item Sections","item":[],"id":"9ec8e0bc-dbdf-4779-bb7a-17a408d8c7ea","_postman_id":"9ec8e0bc-dbdf-4779-bb7a-17a408d8c7ea","description":""},{"name":"Create Review","id":"d224c822-d2c2-4fb6-b3fc-84ed9a4774da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"project\": \"/api/v1/project/45/\",\n    \"name\": \"New API Review\",\n    \"description\": \"Something about the review\",\n    \"group\": \"ep1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://syncsketch.com/api/v1/review/","description":"<p>Create a new review in your project.</p>\n","urlObject":{"protocol":"https","path":["api","v1","review",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d224c822-d2c2-4fb6-b3fc-84ed9a4774da"},{"name":"Get Reviews by Project ID","id":"23d29d04-f15c-45bb-b930-bcb5bfa661ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v1/review/?project__id={{project_id}}&active=1&fields=id,name","urlObject":{"protocol":"https","path":["api","v1","review",""],"host":["syncsketch","com"],"query":[{"key":"project__id","value":"{{project_id}}"},{"key":"active","value":"1"},{"key":"fields","value":"id,name"}],"variable":[]}},"response":[],"_postman_id":"23d29d04-f15c-45bb-b930-bcb5bfa661ff"},{"name":"Get Review by ID","id":"a647961f-9d37-4766-8339-9b2abbe614e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"url":"https://syncsketch.com/api/v1/review/{{review_id}}/","urlObject":{"protocol":"https","path":["api","v1","review","{{review_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a647961f-9d37-4766-8339-9b2abbe614e7"},{"name":"Search Reviews by Name","id":"11705c32-fec6-4bd2-b45a-7a8ecd7aa593","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"url":"https://syncsketch.com/api/v1/review/?name__istartswith=review name&active=1","urlObject":{"protocol":"https","path":["api","v1","review",""],"host":["syncsketch","com"],"query":[{"key":"name__istartswith","value":"review name"},{"key":"active","value":"1"}],"variable":[]}},"response":[],"_postman_id":"11705c32-fec6-4bd2-b45a-7a8ecd7aa593"},{"name":"Update Review","id":"ae99a32e-b2fc-4330-ba49-91a6a8d52f3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"new review name\",\n    \"description\": \"new review description\"\n}"},"url":"https://syncsketch.com/api/v1/review/{{review_id}}/","urlObject":{"protocol":"https","path":["api","v1","review","{{review_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae99a32e-b2fc-4330-ba49-91a6a8d52f3f"},{"name":"Delete Review","id":"8bfe9237-b284-47a7-9f22-675b43b3b67d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"active\": 0\n}"},"url":"https://syncsketch.com/api/v2/review/{{review_id}}/","description":"<p>For now, setting review active to false is how we soft delete reviews.  These reviews are cleaned up and fully removed from our system after 30 days.  Before then, they can be restored by setting active back to 1.</p>\n","urlObject":{"protocol":"https","path":["api","v2","review","{{review_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8bfe9237-b284-47a7-9f22-675b43b3b67d"},{"name":"Lock Review","id":"dbcb3b97-a596-40f2-b4ad-f068ca690b84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://syncsketch.com/api/v2/review/{{review_id}}/lock/","description":"<p>Locked reviews can not have items added/removed and cannot be deleted.</p>\n","urlObject":{"protocol":"https","path":["api","v2","review","{{review_id}}","lock",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbcb3b97-a596-40f2-b4ad-f068ca690b84"},{"name":"Unlock Review","id":"9a9f0811-c152-4557-9bcb-ee7145adad6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://syncsketch.com/api/v2/review/{{review_id}}/unlock/","description":"<p>Locked reviews can not have items added/removed and cannot be deleted.</p>\n","urlObject":{"protocol":"https","path":["api","v2","review","{{review_id}}","unlock",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a9f0811-c152-4557-9bcb-ee7145adad6e"},{"name":"Get Review Storage Usage","id":"7c3e97b0-65b8-4039-b130-125c6d375956","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v2/review/{{review_id}}/storage/","description":"<p>Get a review's storage usage by passing the ID in the url. Response is usage in bytes.</p>\n","urlObject":{"protocol":"https","path":["api","v2","review","{{review_id}}","storage",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c3e97b0-65b8-4039-b130-125c6d375956"},{"name":"Update Items Sort","id":"f0ae1150-a777-4c1a-baf7-b7057d37a2b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"items\": [\n        {\n            \"id\": 1,\n            \"sortorder\": 0\n        },\n        {\n            \"id\": 2,\n            \"sortorder\": 1\n        },\n        {\n            \"id\": 3,\n            \"sortorder\": 2\n        },\n        {\n            \"id\": 4,\n            \"sortorder\": 3\n        },\n        {\n            \"id\": 5,\n            \"sortorder\": 4\n        }\n    ]\n}"},"url":"https://syncsketch.com/api/v2/review/{{review_id}}/sort_items/","description":"<p>Sort items in a review.</p>\n<p>Request body should contain item_id and sortorder for each item you'd like to change the sortorder on.</p>\n","urlObject":{"protocol":"https","path":["api","v2","review","{{review_id}}","sort_items",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0ae1150-a777-4c1a-baf7-b7057d37a2b4"}],"id":"184ee904-e2f8-4fc9-abda-a953b7a7ec88","_postman_id":"184ee904-e2f8-4fc9-abda-a953b7a7ec88","description":""},{"name":"Items","item":[{"name":"Get Items by Review ID","id":"291c7084-1184-4498-8c07-1680fa9e2238","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v1/item/?reviews__id={{review_id}}&active=1&fields=id,name,active,revisions","urlObject":{"protocol":"https","path":["api","v1","item",""],"host":["syncsketch","com"],"query":[{"key":"reviews__id","value":"{{review_id}}"},{"key":"active","value":"1"},{"description":{"content":"<p>fields you want returned - optional</p>\n","type":"text/plain"},"key":"fields","value":"id,name,active,revisions"}],"variable":[]}},"response":[],"_postman_id":"291c7084-1184-4498-8c07-1680fa9e2238"},{"name":"Get Item by ID","id":"29b0dd20-fab4-4fa2-b3d6-201a52d6528f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v1/item/{{item_id}}/?fields=id,name,active,revisions&review_id={{review_id}}","urlObject":{"protocol":"https","path":["api","v1","item","{{item_id}}",""],"host":["syncsketch","com"],"query":[{"description":{"content":"<p>fields you want returned - optional</p>\n","type":"text/plain"},"key":"fields","value":"id,name,active,revisions"},{"description":{"content":"<p>The review ID of one of the reviews this Item is in.  Required to get \"original_url\" value in response</p>\n","type":"text/plain"},"key":"review_id","value":"{{review_id}}"}],"variable":[]}},"response":[],"_postman_id":"29b0dd20-fab4-4fa2-b3d6-201a52d6528f"},{"name":"Upload Item","id":"5bfb74f5-5fe9-4037-b291-6c1576621444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"reviewFile","description":"<p>the file REQUIRED</p>\n","type":"file","value":null},{"key":"artist","value":"john smith","description":"<p>a name to associate as the creator of the file - optional</p>\n","type":"text"},{"key":"description","value":"item description","description":"<p>optional</p>\n","type":"text"}]},"url":"https://syncsketch.com/items/uploadToReview/{{review_id}}/?noConvertFlag=0","urlObject":{"protocol":"https","path":["items","uploadToReview","{{review_id}}",""],"host":["syncsketch","com"],"query":[{"key":"noConvertFlag","value":"0"}],"variable":[]}},"response":[],"_postman_id":"5bfb74f5-5fe9-4037-b291-6c1576621444"},{"name":"Create Item (image) from file url","id":"70774d85-8f47-4d67-820d-fee76d93bb93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"<p>the file REQUIRED</p>\n","key":"imageURL","type":"text","value":"https://www.yourserver.com/files/item.jpeg"},{"key":"type","value":"image","description":"<p>REQUIRED</p>\n","type":"text"},{"description":"<p>a name to associate as the creator of the file - optional</p>\n","key":"artist","type":"text","value":"john smith"},{"description":"<p>optional</p>\n","key":"description","type":"text","value":"item description"}]},"url":"https://syncsketch.com/items/uploadToReview/{{review_id}}/?noConvertFlag=0","urlObject":{"protocol":"https","path":["items","uploadToReview","{{review_id}}",""],"host":["syncsketch","com"],"query":[{"key":"noConvertFlag","value":"0"}],"variable":[]}},"response":[],"_postman_id":"70774d85-8f47-4d67-820d-fee76d93bb93"},{"name":"Create Item (video) from file url","id":"606ed320-5872-4b1c-9cb1-c10e1e080d10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"<p>the file REQUIRED</p>\n","key":"media_url","type":"text","value":"https://www.yourserver.com/files/video.mp4"},{"description":"<p>a name to associate as the creator of the file - optional</p>\n","key":"artist","type":"text","value":"john smith"},{"description":"<p>optional</p>\n","key":"description","type":"text","value":"item description"}]},"url":"https://syncsketch.com/items/uploadToReview/{{review_id}}/?noConvertFlag=0","urlObject":{"protocol":"https","path":["items","uploadToReview","{{review_id}}",""],"host":["syncsketch","com"],"query":[{"key":"noConvertFlag","value":"0"}],"variable":[]}},"response":[],"_postman_id":"606ed320-5872-4b1c-9cb1-c10e1e080d10"},{"name":"Create Item (image) hosted externally","id":"09488e1c-b873-4dda-b936-7c75d6d9111f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"<p>the file REQUIRED</p>\n","key":"external_url","type":"text","value":"https://www.yourserver.com/files/item.jpeg"},{"key":"type","value":"image","description":"<p>REQUIRED</p>\n","type":"text"},{"key":"external_thumbnail_url","value":"https://www.yourserver.com/files/thumbnail.jpeg","description":"<p>REQUIRED</p>\n","type":"text"},{"description":"<p>a name to associate as the creator of the file - optional</p>\n","key":"artist","type":"text","value":"john smith"},{"description":"<p>optional</p>\n","key":"description","type":"text","value":"item description"}]},"url":"https://syncsketch.com/items/uploadToReview/{{review_id}}/?noConvertFlag=0","description":"<p>Provide a persistent file url link to an image that will remain hosted on the external server.</p>\n","urlObject":{"protocol":"https","path":["items","uploadToReview","{{review_id}}",""],"host":["syncsketch","com"],"query":[{"key":"noConvertFlag","value":"0"}],"variable":[]}},"response":[],"_postman_id":"09488e1c-b873-4dda-b936-7c75d6d9111f"},{"name":"Update Item","id":"2ad1100a-612b-49bb-aa2c-7e51d2356331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"test new name\"\n}"},"url":"https://syncsketch.com/api/v1/item/{{item_id}}/","description":"<p>Update an item</p>\n","urlObject":{"protocol":"https","path":["api","v1","item","{{item_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ad1100a-612b-49bb-aa2c-7e51d2356331"},{"name":"Delete Item (single)","id":"75a68ec2-39ab-4407-a2dc-1ae96355a1b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"item_ids\": [1,2,3]\n}"},"url":"https://syncsketch.com/api/v2/item/{{item_id}}/","description":"<p>Pass a list of item ids to delete</p>\n","urlObject":{"protocol":"https","path":["api","v2","item","{{item_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75a68ec2-39ab-4407-a2dc-1ae96355a1b3"},{"name":"Delete Items (bulk)","id":"92bad6d2-a402-4103-bbda-af4cc8167e30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"item_ids\": [1,2,3]\n}"},"url":"https://syncsketch.com/api/v2/bulk-delete-items/","description":"<p>Pass a list of item ids to delete</p>\n","urlObject":{"protocol":"https","path":["api","v2","bulk-delete-items",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"92bad6d2-a402-4103-bbda-af4cc8167e30"},{"name":"Set Item Approval Status","id":"d87a133f-f08b-45e3-8057-316e030ef923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"review_id\": 1,\n    \"approval_status\": \"approved\"\n}"},"url":"https://syncsketch.com/api/v2/item/{{item_id}}/set_approval_status/","description":"<p>Set the approval status for an item in a review</p>\n<p>Options are:</p>\n<ul>\n<li>approved</li>\n<li>reviewed</li>\n<li>in_progress</li>\n<li>on_hold</li>\n<li>no_status</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","v2","item","{{item_id}}","set_approval_status",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d87a133f-f08b-45e3-8057-316e030ef923"}],"id":"d4fd3c50-7f0d-4fb7-8e41-521c31af7d5e","_postman_id":"d4fd3c50-7f0d-4fb7-8e41-521c31af7d5e","description":""},{"name":"Frames (Comments/Sketches)","item":[{"name":"Get All Sketches and Comments for an Item","id":"420d5dfd-b98a-4beb-9208-b4b3ec0693c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v1/frame/?item__id={{item_id}}&limit=100&revision__id={{revision_id}}&created__gte=2024-11-01T20:00:00Z&created__lte=2024-11-01T20:00:00Z","urlObject":{"protocol":"https","path":["api","v1","frame",""],"host":["syncsketch","com"],"query":[{"description":{"content":"<p>The id of the item to query by. REQUIRED</p>\n","type":"text/plain"},"key":"item__id","value":"{{item_id}}"},{"description":{"content":"<p>Adding a limit is recommended - optional</p>\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"<p>Filter by type: \"comment\" or \"sketch\" - optional</p>\n","type":"text/plain"},"key":"type","value":"comment"},{"disabled":true,"description":{"content":"<p>Filter by creator id - optional</p>\n","type":"text/plain"},"key":"creator","value":"1"},{"disabled":true,"description":{"content":"<p>Only include frames after the date - optional</p>\n","type":"text/plain"},"key":"created__gt","value":"2021-01-01"},{"disabled":true,"description":{"content":"<p>Only include frames before the date - optional</p>\n","type":"text/plain"},"key":"created__lt","value":"2021-02-01"},{"description":{"content":"<p>A revision is tied to an item and groups comments/sketches</p>\n","type":"text/plain"},"key":"revision__id","value":"{{revision_id}}"},{"description":{"content":"<p>Created greater than or equal to a full timestamp - optional</p>\n","type":"text/plain"},"key":"created__gte","value":"2024-11-01T20:00:00Z"},{"description":{"content":"<p>Created less than or equal to a full timestamp - optional</p>\n","type":"text/plain"},"key":"created__lte","value":"2024-11-01T20:00:00Z"}],"variable":[]}},"response":[],"_postman_id":"420d5dfd-b98a-4beb-9208-b4b3ec0693c4"},{"name":"Create Comment","id":"66aa8827-2443-4da5-9a8b-96cef4894577","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"item\": \"/api/v1/item/{{item_id}}/\",\n    \"frame\": 1,\n    \"revision\": \"/api/v1/revision/{{revision_id}}/\",\n    \"type\": \"comment\",\n    \"text\": \"Testing through API\"\n}\n"},"url":"https://syncsketch.com/api/v1/frame/?access_type=review&access_id={{review_id}}","description":"<p>Creating a comment is easy once you've gotten all the info you need from the item api.</p>\n<p>To create a comment you need the following:</p>\n<ul>\n<li>review_id</li>\n<li>item_id</li>\n<li>revision_id</li>\n</ul>\n<p>You can get the revision id by querying the item.  You can use any revision id that is associated to the item.</p>\n","urlObject":{"protocol":"https","path":["api","v1","frame",""],"host":["syncsketch","com"],"query":[{"key":"access_type","value":"review"},{"key":"access_id","value":"{{review_id}}"}],"variable":[]}},"response":[],"_postman_id":"66aa8827-2443-4da5-9a8b-96cef4894577"},{"name":"Download Sketch Frames","id":"77148249-6638-462d-9bda-2a2e7b32803c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"}],"url":"https://syncsketch.com/api/v2/downloads/flattenedSketches/{{review_id}}/{{item_id}}/?async=1","description":"<p>This endpoint will return s3 media urls to the sketch overlays on the media frame/images.</p>\n<p>Async=0 must be passed as url param in order to receive the media in the immediate response.</p>\n<p>If async=1 is passed, you receive an ID which can be used to poll for the result in another endpoint:</p>\n<p>GET <a href=\"https://syncsketch.com/api/v2/downloads/flattenedSketches/%7B%7Basync_task_id%7D%7D/\">https://syncsketch.com/api/v2/downloads/flattenedSketches/{{async_task_id}}/</a></p>\n","urlObject":{"protocol":"https","path":["api","v2","downloads","flattenedSketches","{{review_id}}","{{item_id}}",""],"host":["syncsketch","com"],"query":[{"description":{"content":"<p>Whether to run in the background or return the data immediately</p>\n","type":"text/plain"},"key":"async","value":"1"}],"variable":[]}},"response":[],"_postman_id":"77148249-6638-462d-9bda-2a2e7b32803c"},{"name":"Download Sketch Frames async result check","id":"69566a2b-1bcf-41b5-a65b-5c48e73aa0a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"}],"url":"https://syncsketch.com/api/v2/downloads/flattenedSketches/{{async_task_id}}/","description":"<p>This endpoint will return s3 media urls to the sketch overlays on the media frame/images.</p>\n<p>Async=0 must be passed as url param in order to receive the media in the immediate response.</p>\n<p>If async=1 is passed, you receive an ID which can be used to poll for the result in another endpoint:</p>\n<p>GET <a href=\"https://syncsketch.com/api/v2/downloads/flattenedSketches/%7B%7Basync_task_id%7D%7D/\">https://syncsketch.com/api/v2/downloads/flattenedSketches/{{async_task_id}}/</a></p>\n","urlObject":{"protocol":"https","path":["api","v2","downloads","flattenedSketches","{{async_task_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"69566a2b-1bcf-41b5-a65b-5c48e73aa0a7"}],"id":"43da34c2-675b-412b-8a32-c300edd91103","event":[{"listen":"prerequest","script":{"id":"960d4365-ae12-4e34-91b6-49f24543ca24","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3bee64d3-e613-41e8-9a80-e9a63f50cb9d","type":"text/javascript","exec":[""]}}],"_postman_id":"43da34c2-675b-412b-8a32-c300edd91103","description":""},{"name":"User","item":[{"name":"Get all Project Users","id":"e99dfca5-5fe6-4138-85b4-69b2ef81b214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://syncsketch.com/api/v2/all-project-users/{{project_id}}/","urlObject":{"protocol":"https","path":["api","v2","all-project-users","{{project_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e99dfca5-5fe6-4138-85b4-69b2ef81b214"},{"name":"Get all project and workspace connections for a user","id":"23fabcc5-d042-4ae1-bcad-b916de6b32b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://syncsketch.com/api/v2/user/{{user_id}}/connections/account/{{account_id}}/","description":"<p>requires workspace admin rights</p>\n<p>Get a list of project and workspace connections for a user in a workspace. Includes the project/account id and permission name.</p>\n<p>Optional - include connections to archived projects and/or deleted projects.</p>\n","urlObject":{"protocol":"https","path":["api","v2","user","{{user_id}}","connections","account","{{account_id}}",""],"host":["syncsketch","com"],"query":[{"disabled":true,"key":"include_archived","value":"1"},{"disabled":true,"key":"include_inactive","value":"1"}],"variable":[]}},"response":[],"_postman_id":"23fabcc5-d042-4ae1-bcad-b916de6b32b5"},{"name":"Invite Users to Project","id":"33b46342-717b-4dff-a049-6e23cdb91298","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"which\": \"project\",\n    \"entity_id\": {{project_id}},\n    \"note\": \"This is a note to include in the welcome email\",\n    \"users\": [\n        { \"email\": \"admin@emaildomain.com\", \"permission\": \"admin\" },\n        { \"email\": \"member@emaildomain.com\", \"permission\": \"member\" },\n        { \"email\": \"restricted_member@emaildomain.com\", \"permission\": \"restricted_member\" },\n        { \"email\": \"reviewer@emaildomain.com\", \"permission\": \"reviewer\" }\n    ],\n    \"expiration_date\": null\n}"},"url":"https://syncsketch.com/api/v2/add-users/","description":"<p>Add users to a project.</p>\n<p>Pass a list of emails, permission, welcome email text, and optional expiration date.</p>\n<p>Permission options are:</p>\n<ul>\n<li>Admin (has admin access and can alter all project settings)</li>\n<li>Member (Can create and manage all reviews in the project)</li>\n<li>Restricted Member (Can create and reviews in the project. Can only see reviews they created)</li>\n<li>Reviewer (Can view and sketch/comment on all reviews in the project)</li>\n<li>Viewer (Can view all reviews in the project)</li>\n</ul>\n<p>Expiration date should be formatted like: \"2023-12-31\"</p>\n","urlObject":{"protocol":"https","path":["api","v2","add-users",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"33b46342-717b-4dff-a049-6e23cdb91298"},{"name":"Invite Users to Workspace","id":"ea1e930f-1f1f-4926-ac3a-a5cc349db24b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"which\": \"account\",\n    \"entity_id\": {{account_id}},\n    \"note\": \"This is a note to include in the welcome email\",\n    \"users\": [\n        {\n            \"email\": \"admin@emaildomain.com\",\n            \"permission\": \"admin\"\n        },\n        {\n            \"email\": \"manager@emaildomain.com\",\n            \"permission\": \"manager\"\n        },\n        {\n            \"email\": \"billing@emaildomain.com\",\n            \"permission\": \"billing\"\n        }\n    ]\n}"},"url":"https://syncsketch.com/api/v2/add-users/","description":"<p>Add users to a workspace.</p>\n<p>Pass a list of emails, permission, and welcome email text.</p>\n<p>Permission options are:</p>\n<ul>\n<li>Admin (has admin access to all the workspace settings (except billing) and can manage users across the workspace and all projects)</li>\n<li>Manager (Can create projects and administrate those projects. Has no access to workspace settings)</li>\n<li>Billing (Can update subscription details and payment methods, view usage and download reports)</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","v2","add-users",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea1e930f-1f1f-4926-ac3a-a5cc349db24b"},{"name":"Remove Users from Project","id":"16cdb33d-0275-4718-a432-ac0a27053a07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"which\": \"project\",\n    \"entity_id\": {{project_id}},\n    \"users\": [\n        { \"email\": \"someone@emaildomain.com\" },\n        { \"id\": {{user_id}} }\n    ]\n}"},"url":"https://syncsketch.com/api/v2/remove-users/","description":"<p>Remove users from a project.</p>\n<p>Can pass either the user id or the email.</p>\n","urlObject":{"protocol":"https","path":["api","v2","remove-users",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"16cdb33d-0275-4718-a432-ac0a27053a07"},{"name":"Remove Users from Workspace","id":"74f98d54-7322-4241-b09a-652673c1ffd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"which\": \"account\",\n    \"entity_id\": {{account_id}},\n    \"users\": [\n        { \"email\": \"someone@emaildomain.com\" },\n        { \"id\": {{user_id}} }\n    ]\n}"},"url":"https://syncsketch.com/api/v2/remove-users/","description":"<p>Remove users from a workspace.</p>\n<p>Can pass either the user id or the email.</p>\n","urlObject":{"protocol":"https","path":["api","v2","remove-users",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"74f98d54-7322-4241-b09a-652673c1ffd9"}],"id":"4b8fe269-f2ff-4c92-b486-910d10d0054f","_postman_id":"4b8fe269-f2ff-4c92-b486-910d10d0054f","description":""},{"name":"Webhooks","item":[{"name":"List Webhooks for Account","id":"3a912c14-21ad-4ef4-991a-0c72940acb75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://syncsketch.com/api/v2/notifications/{{account_id}}/webhooks/","description":"<p>This returns a JSON array with all currently-configured webhooks for a given account.</p>\n<p>Notes:</p>\n<ul>\n<li>Webhooks (and all API features) are only available for Workspaces on Enterprise or Education Plus plans.</li>\n<li>You must have the api_key with <strong>workspace admin</strong> rights to work with webhooks.</li>\n<li>Best practice is to authenticate using the API username and key for an <a href=\"https://support.syncsketch.com/script-users\">API Script User</a> rather than an individual Workspace admin's auth credentials.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","v2","notifications","{{account_id}}","webhooks",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a912c14-21ad-4ef4-991a-0c72940acb75"},{"name":"Create Webhook","id":"57d9e9c9-7011-43b3-8420-993151c5fa64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apikey {{username}}:{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"url\": \"https://z1mXXXcl0.execute-api.us-east-2.amazonaws.com/default/discord-wh-relay\",\n    \"type\": \"item_created\",\n    \"headers\": {\n        \"X-My-Custom-Header\": \"some-auth-token-etc\"\n    }\n}"},"url":"https://syncsketch.com/api/v2/notifications/{{account_id}}/webhooks/","description":"<p>This endpoint corresponds directly to the <strong>Add new webhook</strong> function in the Workspace Settings view in the SyncSketch web application.</p>\n<p>Webhooks fire for all projects within the workspace that they're configured for.</p>\n<p>Notes:</p>\n<ul>\n<li>Webhooks (and all API features) are only available for Workspaces on Enterprise or Education Plus plans.</li>\n<li>You must have the api_key with <strong>workspace admin</strong> rights to work with webhooks.</li>\n<li>Best practice is to authenticate using the API username and key for an <a href=\"https://support.syncsketch.com/script-users\">API Script User</a> rather than an individual Workspace admin's auth credentials.</li>\n</ul>\n<p>POST Body Properties</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Property</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>url</td>\n<td>String</td>\n<td>The URL of your receiving API that the messages will be sent to.</td>\n</tr>\n<tr>\n<td>type</td>\n<td>String</td>\n<td>The event or action name from the table the follows</td>\n</tr>\n<tr>\n<td>headers</td>\n<td>JSON</td>\n<td>Custom headers and values that will be included in every Webhook message</td>\n</tr>\n</tbody>\n</table>\n</div><p>Notification webhook event types are:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Event Name (****<code>type</code></strong> <strong>values)</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>all</code></td>\n<td>All events</td>\n</tr>\n<tr>\n<td><code>review_ended_notes</code></td>\n<td>New annotations have been added to a Review that has recently ended.  <br />  <br />This action is triggered 16 minutes after the last user has left the Review. Note that this will not be triggered if a reviewer leaves the Review Player open in a browser tab.</td>\n</tr>\n<tr>\n<td><code>review_started</code></td>\n<td>A synced Review session has started</td>\n</tr>\n<tr>\n<td><code>review_ended</code></td>\n<td>This message fires 2 minutes after the last person has left a synced review session.  <br />  <br />Note that this will not be triggered if a reviewer leaves the Review Player open in a browser tab.</td>\n</tr>\n<tr>\n<td><code>review_created</code></td>\n<td>A new Review has been added.</td>\n</tr>\n<tr>\n<td><code>review_deleted</code></td>\n<td>A review has been deleted from a Project</td>\n</tr>\n<tr>\n<td><code>user_added</code></td>\n<td>User added to Workspace or Project</td>\n</tr>\n<tr>\n<td><code>user_removed</code></td>\n<td>User removed from Workspace or Project</td>\n</tr>\n<tr>\n<td><code>project_created</code></td>\n<td>Project created</td>\n</tr>\n<tr>\n<td><code>project_deleted</code></td>\n<td>Project deleted</td>\n</tr>\n<tr>\n<td><code>project_archived</code></td>\n<td>Project archived</td>\n</tr>\n<tr>\n<td><code>project_unarchived</code></td>\n<td>Project restored (unarchived)</td>\n</tr>\n<tr>\n<td><code>item_uploaded</code></td>\n<td>A new media item has been uploaded to a Review.  <br />  <br />This excludes new Whiteboards.</td>\n</tr>\n<tr>\n<td><code>item_deleted</code></td>\n<td>A media item has been deleted from a Review.  <br />  <br />This action is triggered whether the item is deleted from just the Review (but is still in other Reviews) or deleted from the Project (no longer appears in any Review).</td>\n</tr>\n<tr>\n<td><code>item_approval_status_changed</code></td>\n<td>An item's Approval Status has changed, regardless of Review.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v2","notifications","{{account_id}}","webhooks",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57d9e9c9-7011-43b3-8420-993151c5fa64"},{"name":"Delete Webhook","id":"de53555b-822a-4408-ac20-7be51c7b8724","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"apikey {{username}}:{{apiKey}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://syncsketch.com/api/v2/notifications/{{account_id}}/webhooks/{{webhook_id}}/","description":"<p>Notes:</p>\n<ul>\n<li>Webhooks (and all API features) are only available for Workspaces on Enterprise or Education Plus plans.</li>\n<li>You must have the api_key with <strong>workspace admin</strong> rights to work with webhooks.</li>\n<li>Best practice is to authenticate using the API username and key for an <a href=\"https://support.syncsketch.com/script-users\">API Script User</a> rather than an individual Workspace admin's auth credentials.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","v2","notifications","{{account_id}}","webhooks","{{webhook_id}}",""],"host":["syncsketch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"de53555b-822a-4408-ac20-7be51c7b8724"}],"id":"4793d0f3-c78f-4071-b888-ece270df83db","description":"<p>Webhooks are sent for certain events that happen in a SyncSketch Workspace, and can be used to trigger events in other APIs like pipeline actions or chat messages. An example application is documented in <a href=\"https://support.syncsketch.com/syncsketch-webhook-integrations-using-aws\">SyncSketch Webhook Integrations Using AWS</a>.</p>\n<p>These can be configured from the SyncSketch web application in the Workspace Settings, or via this API.</p>\n","event":[{"listen":"prerequest","script":{"id":"b5939964-69cf-4dd3-866b-d2e329f01c0e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4b3a5fe0-126f-419f-ab4a-caf0155e4fde","type":"text/javascript","exec":[""]}}],"_postman_id":"4793d0f3-c78f-4071-b888-ece270df83db"}],"event":[{"listen":"prerequest","script":{"id":"d43aaf0a-fcc3-4d52-9776-290862c734d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8928ca7d-4100-4cce-9a78-39d307bd1177","type":"text/javascript","exec":[""]}}]}