WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-08 18:57:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
56ab0161ab152a6d14e8b1e84a54bf64e9cd761e
OpenSign/assets/js/70853c19.3287cb7f.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>v});var l=s(85893),o=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),r=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),m=s(85162);const h={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 capture document signature completion event",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivsfRhWQH5rM2AQhqFZERRBiyWoE+yDbQS0dLZYUyTLF9uCof8+HCU5stMaGzBs+5LIxzvePc+98QCerx2kM/gDl4XWG1gkkKPLrDBeaAUpPBTIHN8i05YFk3OPrNVl1/e3jEupd6zSgXnd6O3a02Al2xUiK5hwLDjMSSPjxgeLLNdZKFF55sRa8SjKdGkkkleGW1QeEtAGLSfJbQ4p0O0/NCF00SZg8WtA53/TeQXp4Sz2e6u3Ike2RArScMtL9GhjIBYJSqaV5xn5oi/ymh6AGyNFFh2Pvji66QAuK7Dk9EUehcWcWHu0khjzlUFIQS+/YLzLWIrcC3RkEKykf62S81aoNSSw0rbkvi/BPScKIIXCe+PS0ajSwQ5aQgfBynetyjDTJdR1Al74aNDqPC2Jh7qmI4vOaOWaGN6Mxy/pmYYsQ+dWQbIj03+HicuwLbog/beQP+PsKqnJas7cMSJZvToBKJQUCp86UE9vxuOnn1ukV+PJ/xqclYxLizyvGO6F8+4yNILTAbt6CezRoWVKe7bSQeWv/jlMaK22lyGd+74M4+oI46eXMG7VlkuRxyHyoDeo/l0kffe+cU+h7svYq4qXDaSoFM/hBGpf3oB0mAUrfAXp7AD7ATdi0Jyns0W9SKBEX2gaY0a7GDH3BaQw2h1HmUO7ReviBXFmHMeA83wt1HrAjRlqg4qGpuRLR2NgxI0YbSdAProYpsRTQ8VJJEdCuBEfsYKkA9rXSkBQfgrkOdpICtH/+XnO3nQknod5eVrRvSsdg2hpvDOopmKtYhK2E3i5eoSj5UHH3cKIBcFW2rIza7bktGO0Yr7AeEjyt8MJcwYzsWpracjmaq6mukTaSTQdpFAbl87VgM3uViuRCS5pwznhcfFjB223271g/nW0+SB8EZbMotHP6usojOnpWx1/vIYEPNrS3a2maLci64b+d1yNovKo7RBaWFTlJRdEfyt6d25ElEuRoXLYq+nrD/ef2NvhGJJe9v5CyKNPt+9vfp/e0K1Upk2KJsPxcEwiquqSq56jaftoeDx5NJwn+fDc8//pU6NtDI97PzKSi9jv7eZuWnXWLVna+AU1cTqDw4HK7tHKuibx14CWJsAigS23gi+pzmeLOunaiXp7gxWk8L6BPXggx6QuQ9OZZ2OvTjqL6yxD4y/q9ufM/d30ARJYti+jUudkY/mOXk18BynMYQ7xlUU3NGuN5AeQXK0DX5N+cy9NAR6Ihf4I2cQR0n4Qsu5IVb0oT2dLA4X+ErBvGvxCyf6I1a9H9ebkuwYtt5025W5R1/Wf8ajFpQ==",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 capture document signature completion event",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 capture document signature completion event",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivsfRhWQH5rM2AQhqFZERRBiyWoE+yDbQS0dLZYUyTLF9uCof8+HCU5stMaGzBs+5LIxzvePc+98QCerx2kM/gDl4XWG1gkkKPLrDBeaAUpPBTIHN8i05YFk3OPrNVl1/e3jEupd6zSgXnd6O3a02Al2xUiK5hwLDjMSSPjxgeLLNdZKFF55sRa8SjKdGkkkleGW1QeEtAGLSfJbQ4p0O0/NCF00SZg8WtA53/TeQXp4Sz2e6u3Ike2RArScMtL9GhjIBYJSqaV5xn5oi/ymh6AGyNFFh2Pvji66QAuK7Dk9EUehcWcWHu0khjzlUFIQS+/YLzLWIrcC3RkEKykf62S81aoNSSw0rbkvi/BPScKIIXCe+PS0ajSwQ5aQgfBynetyjDTJdR1Al74aNDqPC2Jh7qmI4vOaOWaGN6Mxy/pmYYsQ+dWQbIj03+HicuwLbog/beQP+PsKqnJas7cMSJZvToBKJQUCp86UE9vxuOnn1ukV+PJ/xqclYxLizyvGO6F8+4yNILTAbt6CezRoWVKe7bSQeWv/jlMaK22lyGd+74M4+oI46eXMG7VlkuRxyHyoDeo/l0kffe+cU+h7svYq4qXDaSoFM/hBGpf3oB0mAUrfAXp7AD7ATdi0Jyns0W9SKBEX2gaY0a7GDH3BaQw2h1HmUO7ReviBXFmHMeA83wt1HrAjRlqg4qGpuRLR2NgxI0YbSdAProYpsRTQ8VJJEdCuBEfsYKkA9rXSkBQfgrkOdpICtH/+XnO3nQknod5eVrRvSsdg2hpvDOopmKtYhK2E3i5eoSj5UHH3cKIBcFW2rIza7bktGO0Yr7AeEjyt8MJcwYzsWpracjmaq6mukTaSTQdpFAbl87VgM3uViuRCS5pwznhcfFjB223271g/nW0+SB8EZbMotHP6usojOnpWx1/vIYEPNrS3a2maLci64b+d1yNovKo7RBaWFTlJRdEfyt6d25ElEuRoXLYq+nrD/ef2NvhGJJe9v5CyKNPt+9vfp/e0K1Upk2KJsPxcEwiquqSq56jaftoeDx5NJwn+fDc8//pU6NtDI97PzKSi9jv7eZuWnXWLVna+AU1cTqDw4HK7tHKuibx14CWJsAigS23gi+pzmeLOunaiXp7gxWk8L6BPXggx6QuQ9OZZ2OvTjqL6yxD4y/q9ufM/d30ARJYti+jUudkY/mOXk18BynMYQ7xlUU3NGuN5AeQXK0DX5N+cy9NAR6Ihf4I2cQR0n4Qsu5IVb0oT2dLA4X+ErBvGvxCyf6I1a9H9ebkuwYtt5025W5R1/Wf8ajFpQ==",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={},v=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,o.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Save or Update Webhook"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(a.p,{children:"The save or update Webhook API allow you to save webhook url which is used to capture document signature completion event"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(r.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)(a.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)(a.p,{children:"Provide below parameter to create contact"})})}),(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)(a.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(a.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)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(m.default,{label:"401",value:"401",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(a.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 url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": "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)(a.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(a.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)(d.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)(a.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(a.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,o.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink