Files
OpenSign/assets/js/5c04ee3b.a3248228.js
T

1 line
8.4 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>b,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var l=a(85893),n=a(11151),o=a(58219),i=(a(62316),a(51039)),r=a.n(i),t=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vdtu4zYQ/ZVZvrQLyJdstyhgFMUu2iAIdtEs4Czy4BgBJY0krimSJUd2DENv/ZJ+Wr+kGEpyZKcbFEXRF1+Gc2bmDGcOD4JkGcRiJe4wrazdiHUicgyZV46UNWIhbiuEKyToHeD9p2uQWtsd7G0DZKFEgl1/2HgtEmEdesnw61wsRIk0BE+Ex+CsCRjE4iDezOf8dZpv2WQZhlA0Go5xRCIyawgNsb90TqssHsy+BAYdRMgqrCX/or1DsRA2/YIZiUQ4z2FIdSn7QkeOgbwypUgEPsraaTZVRC4sZrO9bfykR0war9/1LtPM1qJtE0GKIkAZrQw+DOQe3sznDz+ItmWft/O3z0l+DujBWILCNiZ/9d/xQ++tf5ndee6XiHDxA43vn9O4NlupVR5n4tZu0Py/TMbpqUvPpT7WmnFG1h2l6BTPxQnVsb0jGTBrvKK9WKwO4nEinZp054vVul0nokaqbD/TXLCkSizEbHcc74B+iz5EPO/C0yxJ56bWoQmqNFqmgWdoJp2abS9Em5x7B5KlMuXkRdT6qeAlN7Xr20nZx+5Jpz7gXiRDV8ZeiVB8mRXKHH3soDKFjeC+VzcOzVKVJnZ6eyHONeIOdWZrZDWgCmFw//P3PyIit1lTo6E4CK/gpvHg7A4977g0ORQaH1Wq8UlbwiAuAWWtMQS9B2UISy8JIVelIqmBu6JMCZl0MlVa8eiwm2W0h9H0hSncVUgVej76xiNIyHGLmicOtLUbjkMWZEO2jjn6mmFn/abgkhKQkDZBGQwBAuIAQVNJkyEMd5GA9SANoCH0zquAIFXNzoX1gEWhMsWBeU+8zAhqaWSJnCwBrpu74LzdqhwDeJs2gSBY3UQinLFGpI6iQczDFH5RW+yIszFHkkpjDmXDIRLIbI7Qrw3TMDmkGAgcp1cZxqCBpCfQuEUfZy/eZNFoDc7yPiupwRYnd8uByEsTCuvrrqDhao7tc96ynMccudxP4d7cmyUPSxOQB0ArswmLezOB1XHM7jANinD97bAPu93u2R68PsVcKaqaFDw6+4QrozFuzRh+/PNaJILQ1+GmWKLfqmyQ/6/knEXnWa9yMosqh7VUutuxd+cAVhytMjQBR5r0/urTR9jCd9O5SEab/w8Knn28/vny1+Ulx2Wl6fbvYjqfztnkbKBamlGq0dN9vraHJ6n+N698ryyEjzRzWqqorpHMoVfG1fG5XSeisoHYdDikMuBnr9uWzb816Flv14nYSq9kyoKzWrfJoEcspRvcc9eyDB3r7lbqphO1s+flRKOvLm9FImTDlYx1cBN1sP/B0Ycjsx/FPhXIrgD+ZK3+W8CP3LIPuP/p6N6dfBXQ8xu8uX/rtm3/Ah5lWgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",source:"@site/docs/API-docs/get-webhook.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-webhook",permalink:"/docs/API-docs/get-webhook",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vdtu4zYQ/ZVZvrQLyJdstyhgFMUu2iAIdtEs4Czy4BgBJY0krimSJUd2DENv/ZJ+Wr+kGEpyZKcbFEXRF1+Gc2bmDGcOD4JkGcRiJe4wrazdiHUicgyZV46UNWIhbiuEKyToHeD9p2uQWtsd7G0DZKFEgl1/2HgtEmEdesnw61wsRIk0BE+Ex+CsCRjE4iDezOf8dZpv2WQZhlA0Go5xRCIyawgNsb90TqssHsy+BAYdRMgqrCX/or1DsRA2/YIZiUQ4z2FIdSn7QkeOgbwypUgEPsraaTZVRC4sZrO9bfykR0war9/1LtPM1qJtE0GKIkAZrQw+DOQe3sznDz+ItmWft/O3z0l+DujBWILCNiZ/9d/xQ++tf5ndee6XiHDxA43vn9O4NlupVR5n4tZu0Py/TMbpqUvPpT7WmnFG1h2l6BTPxQnVsb0jGTBrvKK9WKwO4nEinZp054vVul0nokaqbD/TXLCkSizEbHcc74B+iz5EPO/C0yxJ56bWoQmqNFqmgWdoJp2abS9Em5x7B5KlMuXkRdT6qeAlN7Xr20nZx+5Jpz7gXiRDV8ZeiVB8mRXKHH3soDKFjeC+VzcOzVKVJnZ6eyHONeIOdWZrZDWgCmFw//P3PyIit1lTo6E4CK/gpvHg7A4977g0ORQaH1Wq8UlbwiAuAWWtMQS9B2UISy8JIVelIqmBu6JMCZl0MlVa8eiwm2W0h9H0hSncVUgVej76xiNIyHGLmicOtLUbjkMWZEO2jjn6mmFn/abgkhKQkDZBGQwBAuIAQVNJkyEMd5GA9SANoCH0zquAIFXNzoX1gEWhMsWBeU+8zAhqaWSJnCwBrpu74LzdqhwDeJs2gSBY3UQinLFGpI6iQczDFH5RW+yIszFHkkpjDmXDIRLIbI7Qrw3TMDmkGAgcp1cZxqCBpCfQuEUfZy/eZNFoDc7yPiupwRYnd8uByEsTCuvrrqDhao7tc96ynMccudxP4d7cmyUPSxOQB0ArswmLezOB1XHM7jANinD97bAPu93u2R68PsVcKaqaFDw6+4QrozFuzRh+/PNaJILQ1+GmWKLfqmyQ/6/knEXnWa9yMosqh7VUutuxd+cAVhytMjQBR5r0/urTR9jCd9O5SEab/w8Knn28/vny1+Ulx2Wl6fbvYjqfztnkbKBamlGq0dN9vraHJ6n+N698ryyEjzRzWqqorpHMoVfG1fG5XSeisoHYdDikMuBnr9uWzb816Flv14nYSq9kyoKzWrfJoEcspRvcc9eyDB3r7lbqphO1s+flRKOvLm9FImTDlYx1cBN1sP/B0Ycjsx/FPhXIrgD+ZK3+W8CP3LIPuP/p6N6dfBXQ8xu8uX/rtm3/Ah5lWgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},b={},j=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"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)(s.p,{children:"Get Webhook"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The Get Webhook API allow you to get webhook url"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(o.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.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:"webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);