mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-08 02:37:40 +02:00
1 line
18 KiB
JavaScript
1 line
18 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>u,contentTitle:()=>x,default:()=>g,frontMatter:()=>p,metadata:()=>j,toc:()=>v});var l=s(85893),a=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA9xdg7Vkpy5QCIdDXUeXExr/QSTDHyzBoXZHu6y55JbkShYEfbsnuUe7JymG3JVWsqs4iJFLL8qH2F7+Zjgz/HFIziyY46llnRt2jeNM6zs2iliCNjaicEIr1mGDDMHyKYI2UBYJdwgVFk4ue8Cl1DOY6xKcDrhZNVoaCbNMxBkIC6XFhBDOiDRFAzhF5exQvXz5svq9M1RDddSCV6+mAmeYdF69GioAgAO4zlCBFalCA2EQEh2XOSoHLhM2aICZkLKeoBVkP3z4EH5ZhB/0b8g8fMg6MGRB3ZBFzXE9/hVj10uGrDNkby5Or86654Pb3psha6ImQmJQsoJcvX+3pUrxfBt0fnLW3UZpV6EuJXKLYJAMA64S73fwsvZ5S7ixXEHH1ngInKWxm/X3jZBs29rvvT3vvn9oaRW+nAu5AeyenfTePYIsMq02VV7+6+K824wjwHL9x2jD8LA2P88/MlUNPKmWdNA76/YHJ2eXW6jYIHePwmrUcqheEwEr5DYDV5wTFirI59KvUrPn39fIvycRhpBqJ0GMLtMMEsMnDhzmhaQUSqlzz50/JXceIEvT0Ng7fxtC+awUg6H6njKTj8fOxBQQMJ7XB+Znsizo+wZIRkNfB8E2mLMl1rD4sw+8JdHq2B94Oi8kfuTIWzOLS1mxy36EXk/IYvXU3wDFvq489rQEhcaJiYh5HZzT7vtB75+905NB95FQr1bzWS5jHqp+IIYmGEvxkdRXY54v+dUa99z8GrlZr84TXgg19FloySKmCzScItpLWIfRs/cv4W1cP6MjZvC3Eq37WSdz1llsPaovjZ6KBP0b2enqsghr4Vgrh8qRIC8KSftPaNX+1ZL0gtk4w5zTbzSLMJjQE/7KSHq+u3mBrFORlEWsMGStE2hJoDSSflQg64xQKYvYRJucu+YXvOe0l1mHZc4VttNuz3VpDqrX/UFp5E8VpBXrnC2XEXPCeYEKczsm35dLGjJoC61ssOH14eHDkPTLOEZrJ6WEVXQ/JRK73TZoS+ke83ztZ13WCCuZgF1ZJOcvNhwUith0Wzt1+/rw8PbHytPjR53TObpMqBRmPhcZrdIIirCZnZkDT7lQQE8D8+L5vEZjtNnt9KdZtisIx4eHt0erIBw9DMJ1ozDEpUGezAHvhXX2y7q8y47dDh7dzlYOHj908MqiAaUdTHSpki/r1Pbcux05Xrnxw0M3emrKpUj8G3Wg71B9WU+a07swPZl6n/vERYeQd8mD/DjbcLX5PThpMS6NcHPWuVmw+wNeiIMw3rkZLUcRow2gKY8X2nqLuctYh7Vnq3Rs0UzRWK/AJ9BVTrRcJWN939IFKjpIJR9byodtXoj29Igto20JXhSfgLaOp0KlBzulRmsf+7QOIdQbnq4CzgvxC85ZVAeyiYqYoPXPkCdofNBped+vD7JuvUjbZu4+GkjvRHsjqmW6KFD16eJCizw9YttF52uUsc7RV4wzhBr+33//x0vUNx3PwRdwURoo9AwNHR50J5pIvBdjiesKtV2VqJHnEq2VcxDKYWro4E1EKhwPjxpKhTEv+FhIQawlmCZpAw3i2xbdP12Ghob+ahA4JDhFSWQHqfUd6XEaeOl07ueob6ozbe4mZFIEHMalFQqtBYtYi6DKuIoR6jWNqPTOFaByaAojLAIXOYEn2gBOJiIWpJi2qOGxg5wrniJNFgHZTVEowo3DgtHj0jqwWpbeEZoxR3TBRYWY2Ba8EVMMjtPHBB0XEhNIS1IRQawThGqJyQ2VwBitg4KmFzF6pdZx40DiFI3nsF9JOkyh0JRKBJegJxtrS4qc4crSdSQYVC/NKnyF0XQq+zkSPm8B9Q3oFKMeAxFACnVH3YQDuFnR7BrHVjgc/a0m7Gw2e7CfvtuUeStcVo7BYKHXcqn/6HdfU3z1x3csYg5Nbi8mfTRTEdcXqD+Ys+3B7SrB8tgnWH+BDnv1p20B2k1SxKgsNtLhydvLdzCF71uHLGpszScY3H7XO+2e97ukl3Jc2H9HrcPWIX2ilJhz1ZiqX/WCrjZ6Qds7eLE+MPYdpP0Lcd9B2neQvkH+7TtIe+7sO0j7DtK+g7TvIP0f5rF9B2nfQfpTc/N/2EGqynEO7127kFz4KmbVnAkFyJu6j0JNnYxKk50btliMucUrI5dL+vxbiYbqmqOITbkRfEzVtZvRMqqLeFSxvMM567DT8B4/GNDEBJdlqAduFXOpBhkkTuIYC7cT26yeXl70Byxi46rhleuEZAyfUTOMz1iHEXF888wXnnxbhr4vmOQqLXlK+KCXao+8pCg0C5d3vnBZ/UKe1UNq3rBys6IZXKH/ybFHBf5OV+lfcP6PFTyM/KFAFdsaTWs3Wi6XvwPeFPIT",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",source:"@site/docs/API-docs/save-update-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/save-update-webhook",permalink:"/docs/API-docs/save-update-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA9xdg7Vkpy5QCIdDXUeXExr/QSTDHyzBoXZHu6y55JbkShYEfbsnuUe7JymG3JVWsqs4iJFLL8qH2F7+Zjgz/HFIziyY46llnRt2jeNM6zs2iliCNjaicEIr1mGDDMHyKYI2UBYJdwgVFk4ue8Cl1DOY6xKcDrhZNVoaCbNMxBkIC6XFhBDOiDRFAzhF5exQvXz5svq9M1RDddSCV6+mAmeYdF69GioAgAO4zlCBFalCA2EQEh2XOSoHLhM2aICZkLKeoBVkP3z4EH5ZhB/0b8g8fMg6MGRB3ZBFzXE9/hVj10uGrDNkby5Or86654Pb3psha6ImQmJQsoJcvX+3pUrxfBt0fnLW3UZpV6EuJXKLYJAMA64S73fwsvZ5S7ixXEHH1ngInKWxm/X3jZBs29rvvT3vvn9oaRW+nAu5AeyenfTePYIsMq02VV7+6+K824wjwHL9x2jD8LA2P88/MlUNPKmWdNA76/YHJ2eXW6jYIHePwmrUcqheEwEr5DYDV5wTFirI59KvUrPn39fIvycRhpBqJ0GMLtMMEsMnDhzmhaQUSqlzz50/JXceIEvT0Ng7fxtC+awUg6H6njKTj8fOxBQQMJ7XB+Znsizo+wZIRkNfB8E2mLMl1rD4sw+8JdHq2B94Oi8kfuTIWzOLS1mxy36EXk/IYvXU3wDFvq489rQEhcaJiYh5HZzT7vtB75+905NB95FQr1bzWS5jHqp+IIYmGEvxkdRXY54v+dUa99z8GrlZr84TXgg19FloySKmCzScItpLWIfRs/cv4W1cP6MjZvC3Eq37WSdz1llsPaovjZ6KBP0b2enqsghr4Vgrh8qRIC8KSftPaNX+1ZL0gtk4w5zTbzSLMJjQE/7KSHq+u3mBrFORlEWsMGStE2hJoDSSflQg64xQKYvYRJucu+YXvOe0l1mHZc4VttNuz3VpDqrX/UFp5E8VpBXrnC2XEXPCeYEKczsm35dLGjJoC61ssOH14eHDkPTLOEZrJ6WEVXQ/JRK73TZoS+ke83ztZ13WCCuZgF1ZJOcvNhwUith0Wzt1+/rw8PbHytPjR53TObpMqBRmPhcZrdIIirCZnZkDT7lQQE8D8+L5vEZjtNnt9KdZtisIx4eHt0erIBw9DMJ1ozDEpUGezAHvhXX2y7q8y47dDh7dzlYOHj908MqiAaUdTHSpki/r1Pbcux05Xrnxw0M3emrKpUj8G3Wg71B9WU+a07swPZl6n/vERYeQd8mD/DjbcLX5PThpMS6NcHPWuVmw+wNeiIMw3rkZLUcRow2gKY8X2nqLuctYh7Vnq3Rs0UzRWK/AJ9BVTrRcJWN939IFKjpIJR9byodtXoj29Igto20JXhSfgLaOp0KlBzulRmsf+7QOIdQbnq4CzgvxC85ZVAeyiYqYoPXPkCdofNBped+vD7JuvUjbZu4+GkjvRHsjqmW6KFD16eJCizw9YttF52uUsc7RV4wzhBr+33//x0vUNx3PwRdwURoo9AwNHR50J5pIvBdjiesKtV2VqJHnEq2VcxDKYWro4E1EKhwPjxpKhTEv+FhIQawlmCZpAw3i2xbdP12Ghob+ahA4JDhFSWQHqfUd6XEaeOl07ueob6ozbe4mZFIEHMalFQqtBYtYi6DKuIoR6jWNqPTOFaByaAojLAIXOYEn2gBOJiIWpJi2qOGxg5wrniJNFgHZTVEowo3DgtHj0jqwWpbeEZoxR3TBRYWY2Ba8EVMMjtPHBB0XEhNIS1IRQawThGqJyQ2VwBitg4KmFzF6pdZx40DiFI3nsF9JOkyh0JRKBJegJxtrS4qc4crSdSQYVC/NKnyF0XQq+zkSPm8B9Q3oFKMeAxFACnVH3YQDuFnR7BrHVjgc/a0m7Gw2e7CfvtuUeStcVo7BYKHXcqn/6HdfU3z1x3csYg5Nbi8mfTRTEdcXqD+Ys+3B7SrB8tgnWH+BDnv1p20B2k1SxKgsNtLhydvLdzCF71uHLGpszScY3H7XO+2e97ukl3Jc2H9HrcPWIX2ilJhz1ZiqX/WCrjZ6Qds7eLE+MPYdpP0Lcd9B2neQvkH+7TtIe+7sO0j7DtK+g7TvIP0f5rF9B2nfQfpTc/N/2EGqynEO7127kFz4KmbVnAkFyJu6j0JNnYxKk50btliMucUrI5dL+vxbiYbqmqOITbkRfEzVtZvRMqqLeFSxvMM567DT8B4/GNDEBJdlqAduFXOpBhkkTuIYC7cT26yeXl70Byxi46rhleuEZAyfUTOMz1iHEXF888wXnnxbhr4vmOQqLXlK+KCXao+8pCg0C5d3vnBZ/UKe1UNq3rBys6IZXKH/ybFHBf5OV+lfcP6PFTyM/KFAFdsaTWs3Wi6XvwPeFPIT",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"},next:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"}},u={},v=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function E(e){const n={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(n.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(n.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(n.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "viewed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"created:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["When document is created through draft template API this event will trigger.","\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "created",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE",\n "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(n.ol,{start:"3",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"signed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"completed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "completed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"declined:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:'{\n "event": "declined",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(n.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(n.p,{children:"Provide url to create Webhook"})})}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(m.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(n.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(n.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(E,{...e})}):E(e)}}}]); |