WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-22 07:32:31 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
be795859cd3b929f89811236c3ecb06151c63af2
OpenSign/assets/js/70853c19.fcb2cecf.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>v});var l=a(85893),o=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),t=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),p=a(9472),m=a(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 trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVltv2zYU/ivseRhWQLbsNgMGYRiaFUERtFiCOsEebCOgpWOJNUWyJGVbMPTfh0NJjuy0xgZsw14SmTy37zs3HsDz3EEyhz9wVWi9gWUEGbrUCuOFVpDAQ4HM8S0ybVllMu6RdbLs+v6WcSn1jtW6Yl63crvutrKS7QqRFkw4VjnMSMJbkedoGW5RebdQEIE2aDk5u80gATLxQ+unDykCi18rdP43ndWQHM4CvLd6KzJkK6RIDLe8RI+WvKUWKd5UK89TDxHQFypPRrgxUqTBcfzFkaUDuLTAktMXeRQWM6Lm0UqixdcGIQG9+oLBlrEUuRfoSKGykv51Qs5boXKIYK1tyf3wBPe8NJKECu+NS+K41pUddayNKivfdSLjVJfQNBF44YNCJ/O0Ih6ahq4sOqOVa2N4M5m8pGdWpSk6t64kOzL9d5i4DNuiq6T/FvJnnH25tFnNmDtGJOtXJwCFkkLhUw/q6c1k8vRzh/RqMv1fg7OScWmRZzXDvXDeXYZGcHpgVy+BPTq0TGnP1rpS2at/DhNaq+1lSOe+L8O4OsL46SWMW7XlUmRhUjzoDar/FsnQvW/dU6j7MvSq4mULKQiFeziBOjxvQTpMKyt8Dcn8APsRN2LU3ifzZbOMoERfaBpjRrsQMfcFJBDvjqPMod2idcFAmBnHMeA8z4XKR9yYsTaonMiV5CtHYyDmRsTbKZCPPoYZ8dRScRLJkRBuxEesIeqBDqUiEJSfAnmGNpBC9H9+nrM3PYnnYV6eVmR3rUMQHY13BtVM5CokYTuFl/tFONoQdJ3ptCpR+VAQbK0tO9NmK06LRCvmCwyXdP52PGXOYCrWXS2N2UIt1EyXSIuHpoMUauOShRqx+d16LVLBJa0xJzwuf+yh7Xa7F8y/DjofhC+qFbNo9LN4Hg5DeoZaxx+vIQKPtnR36xnarUj7of8dV3EQjrsOoYVFVV5yQfR3R+/OlYhyKVJUDgc1ff3h/hN7O55ANMjeXwg5/nT7/ub32Q1ZpTJtUzQdT8YTOqKqLrkaOJp1L4PHk5fBeZIPzz3/778nuur3uPexkVyEpu7Wc9uP836T0lovqFOTORwOVFuPVjYNHX+t0FKbLyPYciv4iop5vmyivmeogTdYQwLvW2yjB3JM4rJq2+9stjVRr3Gdpmj8RdnhMLm/mz1ABKvu+VPqjHQs39HTiO8ggQUsIDylyEK7u+j8AJKrvOI5ybd2qdV5RSwM58QmzInug5D1V6oeRHk6QFoo9JeAfVPhF8roR6x/PYq3N99V6LjtpSl3y6Zp/gTx1bCJ",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:"eJzNVltv2zYU/ivseRhWQLbsNgMGYRiaFUERtFiCOsEebCOgpWOJNUWyJGVbMPTfh0NJjuy0xgZsw14SmTy37zs3HsDz3EEyhz9wVWi9gWUEGbrUCuOFVpDAQ4HM8S0ybVllMu6RdbLs+v6WcSn1jtW6Yl63crvutrKS7QqRFkw4VjnMSMJbkedoGW5RebdQEIE2aDk5u80gATLxQ+unDykCi18rdP43ndWQHM4CvLd6KzJkK6RIDLe8RI+WvKUWKd5UK89TDxHQFypPRrgxUqTBcfzFkaUDuLTAktMXeRQWM6Lm0UqixdcGIQG9+oLBlrEUuRfoSKGykv51Qs5boXKIYK1tyf3wBPe8NJKECu+NS+K41pUddayNKivfdSLjVJfQNBF44YNCJ/O0Ih6ahq4sOqOVa2N4M5m8pGdWpSk6t64kOzL9d5i4DNuiq6T/FvJnnH25tFnNmDtGJOtXJwCFkkLhUw/q6c1k8vRzh/RqMv1fg7OScWmRZzXDvXDeXYZGcHpgVy+BPTq0TGnP1rpS2at/DhNaq+1lSOe+L8O4OsL46SWMW7XlUmRhUjzoDar/FsnQvW/dU6j7MvSq4mULKQiFeziBOjxvQTpMKyt8Dcn8APsRN2LU3ifzZbOMoERfaBpjRrsQMfcFJBDvjqPMod2idcFAmBnHMeA8z4XKR9yYsTaonMiV5CtHYyDmRsTbKZCPPoYZ8dRScRLJkRBuxEesIeqBDqUiEJSfAnmGNpBC9H9+nrM3PYnnYV6eVmR3rUMQHY13BtVM5CokYTuFl/tFONoQdJ3ptCpR+VAQbK0tO9NmK06LRCvmCwyXdP52PGXOYCrWXS2N2UIt1EyXSIuHpoMUauOShRqx+d16LVLBJa0xJzwuf+yh7Xa7F8y/DjofhC+qFbNo9LN4Hg5DeoZaxx+vIQKPtnR36xnarUj7of8dV3EQjrsOoYVFVV5yQfR3R+/OlYhyKVJUDgc1ff3h/hN7O55ANMjeXwg5/nT7/ub32Q1ZpTJtUzQdT8YTOqKqLrkaOJp1L4PHk5fBeZIPzz3/778nuur3uPexkVyEpu7Wc9uP836T0lovqFOTORwOVFuPVjYNHX+t0FKbLyPYciv4iop5vmyivmeogTdYQwLvW2yjB3JM4rJq2+9stjVRr3Gdpmj8RdnhMLm/mz1ABKvu+VPqjHQs39HTiO8ggQUsIDylyEK7u+j8AJKrvOI5ybd2qdV5RSwM58QmzInug5D1V6oeRHk6QFoo9JeAfVPhF8roR6x/PYq3N99V6LjtpSl3y6Zp/gTx1bCJ",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 b(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:"Save or Update Webhook"})}),"\n",(0,l.jsx)(r(),{method:"post",path:"/webhook"}),"\n",(0,l.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{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)(s.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)(s.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)(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)(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)(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:"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)(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)(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)(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:"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)(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)(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)(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)(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)(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)(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)(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)(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 f(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink