Files
OpenSign/assets/js/5c04ee3b.ab27f80c.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:()=>j,contentTitle:()=>u,default:()=>g,frontMatter:()=>m,metadata:()=>x,toc:()=>b});var l=a(85893),o=a(11151),t=a(58219),i=(a(62316),a(51039)),n=a.n(i),r=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),h=a(9472),p=a(85162);const m={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:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7CzFNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3dXbnub9GhIsfaLx5SuNGb1DJPM7ErVmT/n+ZjNOHLj2XuqsV4zTWHaXoFM/FCdWxvSPpKWucDHsxXx7E7gKtvOjO58tVu0pETaEy/UxzwRgqMRfT7XG8PbkNOR/xvAuPs4TWTowl7WWpFaaeZ2iKVk43l6JNzr19wFLq8uIfolDnqdk9j1g9UlzwNXSdPiF67Dda+Z72Ihn6OPZKhOTrrwhzcrHnUhcmgvvufrSkF7LU8W42l+JcVe5IZaYm1o9QEQzuf/z2e0TkJmtq0iGOzgv42DiwZkuOVQF1DoWinUwVPaqRH+TIE9aKvFd7kDpQ6TAQ5LKUARVwV6QuIUOLqVSSh43dDKMdjObVT+CuolCR46NvHAFCThtSPKOgjFlznGAAm2DqmKOvGbbGrQsuKQGEtPFSk/fgiQYI6Qp1RjDcRQLGAWogHchZJz0BypqdC+OAikJmkgPzZjnMAtSosSROlgDXzV2wzmxkTh6cSRsfwBvVRCKcsSYKHUVNlPsJ/Cw31BFnY04BpaIcyoZDJJCZnKBfNKahc0jJB7CcXmYUg/qALoCiDbk4rfEmi0YpsIYVQKICU5zcLQcKDrUvjKu7goarObbPOsMPQMyR434C9/peL3hYGk88AErqtZ/f6wtYHsfsjlIvA62+HXZhu90+2YOXp5hrGaomBUfWPOLKaIxbM4Yf/3gpEhHI1f5jsSC3kdnwYDyTcxqdp70uYhZ1kWqUqtuxt+cA1iglM9KeRir27vrTB9jAd5OZSEZb/zcKnn64+enql8UVx2Vt6vbvcjKbzNhkjQ816lGq0WN/vraHR3H/N/8X9MoSaBemVqGMehzJHHotXR4f6FUiKuMDmw6HFD19dqpt2fxrQ44VepWIDTqJKQvOctUmgx6x+K5pz13LMrKs1BtUTSdqZw/SiapfX92KRGDDlYx1cB11sP/B0YcjvR/FPhXIrgD+ZJ3+S8AP3LL3tP/x6N6dPAvo+Q3e3L9V27Z/AuOba9U=",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:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7CzFNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3dXbnub9GhIsfaLx5SuNGb1DJPM7ErVmT/n+ZjNOHLj2XuqsV4zTWHaXoFM/FCdWxvSPpKWucDHsxXx7E7gKtvOjO58tVu0pETaEy/UxzwRgqMRfT7XG8PbkNOR/xvAuPs4TWTowl7WWpFaaeZ2iKVk43l6JNzr19wFLq8uIfolDnqdk9j1g9UlzwNXSdPiF67Dda+Z72Ihn6OPZKhOTrrwhzcrHnUhcmgvvufrSkF7LU8W42l+JcVe5IZaYm1o9QEQzuf/z2e0TkJmtq0iGOzgv42DiwZkuOVQF1DoWinUwVPaqRH+TIE9aKvFd7kDpQ6TAQ5LKUARVwV6QuIUOLqVSSh43dDKMdjObVT+CuolCR46NvHAFCThtSPKOgjFlznGAAm2DqmKOvGbbGrQsuKQGEtPFSk/fgiQYI6Qp1RjDcRQLGAWogHchZJz0BypqdC+OAikJmkgPzZjnMAtSosSROlgDXzV2wzmxkTh6cSRsfwBvVRCKcsSYKHUVNlPsJ/Cw31BFnY04BpaIcyoZDJJCZnKBfNKahc0jJB7CcXmYUg/qALoCiDbk4rfEmi0YpsIYVQKICU5zcLQcKDrUvjKu7goarObbPOsMPQMyR434C9/peL3hYGk88AErqtZ/f6wtYHsfsjlIvA62+HXZhu90+2YOXp5hrGaomBUfWPOLKaIxbM4Yf/3gpEhHI1f5jsSC3kdnwYDyTcxqdp70uYhZ1kWqUqtuxt+cA1iglM9KeRir27vrTB9jAd5OZSEZb/zcKnn64+enql8UVx2Vt6vbvcjKbzNhkjQ816lGq0WN/vraHR3H/N/8X9MoSaBemVqGMehzJHHotXR4f6FUiKuMDmw6HFD19dqpt2fxrQ44VepWIDTqJKQvOctUmgx6x+K5pz13LMrKs1BtUTSdqZw/SiapfX92KRGDDlYx1cB11sP/B0YcjvR/FPhXIrgD+ZJ3+S8AP3LL3tP/x6N6dPAvo+Q3e3L9V27Z/AuOba9U=",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"}},j={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,o.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)(n(),{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)(t.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.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)(d.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)(c.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.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)(d.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)(c.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.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)(d.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]);