WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 01:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
d46a06595f059c53d26c213a98dbdd5d47931014
OpenSign/assets/js/70853c19.312ca6fb.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>g});var a=l(85893),n=l(11151),i=l(58219),r=(l(62316),l(51039)),o=l.n(r),d=(l(82723),l(9487)),t=(l(41429),l(5397)),c=l(4667),h=l(9472),p=l(85162);const m={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:"eJztVm1r20gQ/ivbCRzXIL81KRziOJoroYSWJpwT+sE2YS2NpW1Wu+ruyoow+u/HrCRbsRunB8dxH/olkXden5nZZ2cDjicWwhl8wWWq9QMsAojRRkbkTmgFIdymyCxfI9OGFXnMHbJWl13cXDEupS5ZpQvmdKNXttLCSFamIkqZsKywGJOGMyJJ0DBco3J2rk5OTtrvcK7majJkp6drgSXG4enpXDHG2IB9SVExKxKFhjVCFuuoyFA55lJhGw+sFFJ2AYaN7Vy9IY+RQe4OXW6dCMtalRf9nZE/n8tRd40GW1Zd3s/7natzn6POcokvZLlzy6VsXdsXc35L/mOMpHgh607nh/KGAHSOhtOcXMUQAnX/l2ZEumkKwOC3Aq37U8cVhJu92boxei1i9KPidNsDtjOOtHKoHBnyPJci8sFGXy1Zb8BGKWacviiKMBjTJN8ZSVPsqhwhBL38ipGDAHJD2TqBlgwKI+lfq2SdESqBAFbaZNz1T/CRU18ghNS53IajUaULM2iHfFAY+a5VGUY6g7oOwAnnDVqd+yVhr2sSGbS5VrbJ4c14fFiSaRFFaO2qkGxb3X9SieOwDdpCuu8h3+HsbnfTyZjZbUayevUEoFA0LfcdqPs34/H9by3S8/Hkfw3OSMalQR5XDB+FdfY4NILTATs/BHZn0TClHVvpQsWv/j1MaIw2xyHtxz4O43wL4+0hjCu15lLEnthv9QOq/xZJP7xrwlOqj5m/q4pnDSSv5OXwBGr/vAFpMSqMcBWEsw08DnguBo08nC3qRQAZulQTdeXa+oy5SyGEUbllIItmjcZ6B54ztjRgHU+ESgY8z4c6R0V8KfnSEg2MeC5G6wlQjC6HKdWpKcWTTLYF4bn4iBUEHdC+VgCC+pMij9H4olD5/9px62VXxP00j7MV+V1pn0Rbxusc1VQkyjdhPYHDdUBYeipI3D0dfiDYShu2Z82WnN59rZhL0Qvp/Gw4YTbHSKzaWRoyegWnOkPaE4gdpFAPtBEM2Ox6tRKR4JKeBSscLn7toJVleVD5197mg3BpsWQGc71TT/yhb0/favvjNQTg0GT2ejVFsxZRR/rPhBp55VF7Q3jkbwhmXFD526N3+0ZUcikiVBZ7M33x4eYTOxuOIeh17wdSHn26en/5eXpJXmlMmxZNhuPhmI5oqjOueoGm7SJ392SR22/yZnfnf65/P9e/Z9e/lrgcPrpRLrnwfNxuVg2VzroliDaylEg2nMFmQ7RwZ2Rd0/G3Ag0x9CKANTeCL4mHZos66OiOuPcBKwjhfTOWg1sKTOqyaJhz71mqg87iIoowd0d1++/AzfX0FgJYtttqpmOyMbykTZaXEMIc5uA3X/LQrB10vgHJVVLwhPQbv8TSvKAq9Cn+wVN8+0HIOpGqelk+5f4GCv0lYN81+J0u40es/tiqN5JnDdradtrUu0Vd138DUmTT1g==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:"eJztVm1r20gQ/ivbCRzXIL81KRziOJoroYSWJpwT+sE2YS2NpW1Wu+ruyoow+u/HrCRbsRunB8dxH/olkXden5nZZ2cDjicWwhl8wWWq9QMsAojRRkbkTmgFIdymyCxfI9OGFXnMHbJWl13cXDEupS5ZpQvmdKNXttLCSFamIkqZsKywGJOGMyJJ0DBco3J2rk5OTtrvcK7majJkp6drgSXG4enpXDHG2IB9SVExKxKFhjVCFuuoyFA55lJhGw+sFFJ2AYaN7Vy9IY+RQe4OXW6dCMtalRf9nZE/n8tRd40GW1Zd3s/7natzn6POcokvZLlzy6VsXdsXc35L/mOMpHgh607nh/KGAHSOhtOcXMUQAnX/l2ZEumkKwOC3Aq37U8cVhJu92boxei1i9KPidNsDtjOOtHKoHBnyPJci8sFGXy1Zb8BGKWacviiKMBjTJN8ZSVPsqhwhBL38ipGDAHJD2TqBlgwKI+lfq2SdESqBAFbaZNz1T/CRU18ghNS53IajUaULM2iHfFAY+a5VGUY6g7oOwAnnDVqd+yVhr2sSGbS5VrbJ4c14fFiSaRFFaO2qkGxb3X9SieOwDdpCuu8h3+HsbnfTyZjZbUayevUEoFA0LfcdqPs34/H9by3S8/Hkfw3OSMalQR5XDB+FdfY4NILTATs/BHZn0TClHVvpQsWv/j1MaIw2xyHtxz4O43wL4+0hjCu15lLEnthv9QOq/xZJP7xrwlOqj5m/q4pnDSSv5OXwBGr/vAFpMSqMcBWEsw08DnguBo08nC3qRQAZulQTdeXa+oy5SyGEUbllIItmjcZ6B54ztjRgHU+ESgY8z4c6R0V8KfnSEg2MeC5G6wlQjC6HKdWpKcWTTLYF4bn4iBUEHdC+VgCC+pMij9H4olD5/9px62VXxP00j7MV+V1pn0Rbxusc1VQkyjdhPYHDdUBYeipI3D0dfiDYShu2Z82WnN59rZhL0Qvp/Gw4YTbHSKzaWRoyegWnOkPaE4gdpFAPtBEM2Ox6tRKR4JKeBSscLn7toJVleVD5197mg3BpsWQGc71TT/yhb0/favvjNQTg0GT2ejVFsxZRR/rPhBp55VF7Q3jkbwhmXFD526N3+0ZUcikiVBZ7M33x4eYTOxuOIeh17wdSHn26en/5eXpJXmlMmxZNhuPhmI5oqjOueoGm7SJ392SR22/yZnfnf65/P9e/Z9e/lrgcPrpRLrnwfNxuVg2VzroliDaylEg2nMFmQ7RwZ2Rd0/G3Ag0x9CKANTeCL4mHZos66OiOuPcBKwjhfTOWg1sKTOqyaJhz71mqg87iIoowd0d1++/AzfX0FgJYtttqpmOyMbykTZaXEMIc5uA3X/LQrB10vgHJVVLwhPQbv8TSvKAq9Cn+wVN8+0HIOpGqelk+5f4GCv0lYN81+J0u40es/tiqN5JnDdradtrUu0Vd138DUmTT1g==",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"}},j={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:l}=s;return l||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,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(o(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"viewed:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"created:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"signed:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"completed:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"declined:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(p.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "result": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink