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
8bd76bc3db39e4bbc28c4c6c406dbba12e3e9303
OpenSign/assets/js/70853c19.583ba3e8.js
T

1 line
15 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var l=n(85893),a=n(11151),i=n(58219),r=(n(62316),n(51039)),d=n.n(r),o=(n(82723),n(9487)),t=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={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:"eJztWG1vGjkQ/iuuK52u0fKSJpVOq9OptEU91LygQtQPgFKzO4AbY29tLwSh/e+nsXdhWdIkp+ZyqkQ+BLCfsecZPzvemTW1bGpoOKBfYDxT6oaOAhqDiTRPLFeShrQ/A2LYAojSJE1iZoHkWNLqdggTQi3JSqXEKo9b5rOpFmQ549GMcENSAzEirObTKWgCC5DWDOXLly/z7+FQDuVxnRwdLTgsIQ6PjoaSEEJq5MsMJDF8KkETP0liFaVzkJbYGTd+BbLkQhQb1L3t169f/Ze1/8C/IXXwIQ3JkPrlhjQoz0+4AD/94fL91Xn7on999fmsApJsXgVdtM7bVZSyOaorgBkgGnBLwmTsGHn/CzYV49JB+DUq8z4kBucG2/EdslVfe52PF+3P+57mgZkzLnaA7fNW5+wOZDJTcnfJ7t+XF+0hLQOz7Y/RjuM+6u9WD2xVAFv5YfU75+1ev3XeraAiDczeCStQ2VC+RmnlyKq2NmrihuSQnxVWvsxBWc+rrEdJwUHlCQrCEb1XDx5BxqsiA/2kMPx6lXir8TeIbCce0rB06p0PZdYH9TyZekpmoz3HfzrdZKiuU5du1DwR8EDC2QqMCZGLzDygskfkn2LrQwb6bzT0wwxUBP5Jbi0HlW9QTDFEgj+QrArM06WrYsWDjJ5XRkXcH/GSVECfRHA0oCoBzTCinZiGFN/pf/Mv/kWNEFAN31Mw9p2KVzRcVyqGrlYLHoMrAKzKX6jI1jhS0oK0aMiSRPDIbdb4ZtB6TU00gznDb7gL1xBjfXKlBdYmdpUADfP7kgY00eit5WDQINUCP3KQsZrLKQ3oROk5s+URuGX4lNKQzqxNTNhorFSqa3npUku1eJtD6pGa0ywLqOXWGeSY6zFyzzKc0mASJY334XWzuR+SXhpFYMwkFWQT3X8TiftpazCpsHcx3/IsajZ/kjExG4/E6sUOQS5RTdcFqevXzeb1HznT0+bxPrkvpYKPCQ0sXhG45caaF0/HEbRW+pEU7/DjPoKnzePr5Ybg6T7BKwOaSGXJRKUyfl5S1b3vJ3K6ofFmn0ZHLpjgsSvb++oG5PMyKW9v/fbo6u3cPbOYfx0lB3LzdIdqedyTNBClmtsVDQdreltjCa/5+XAwykYBnYOdKUxhiTLOY2ZnNKSN5SYTGdAL0MYt4HLHJh0Yy6ZcTmssSeoqAYn3iGBjg+mgwRLeWBxT3KPwoYdx8qHY8WQTEJbwT7CiQUG0jAoox/OZAYtBu6Bg+D9vc2y7CGLVzfuzFq47Uc6JPIyXCcge3ql4CItjut/s4QbfI3C6uHGdIMhEaVKxJmOGXR2FNzS4SRw/qR8Tk0DEJ7mW6gQ7Oz01B+wCYQoUXN5gv6dGBpeTCY84E3g9GG5h9HtBbblc7kX+lbP5yO0sHRMNidrCp27QHU/ZavPjFQ2oBT03l5Me6AWPiuT/g60aDtzInxAWuSfEXf40LIbeVo0w5IJHIA2UNN362D0jJ/UmDUqn9wiXG2ed9+2LXhtXRZn6IzquN+tNHEJVz5ksbdTL23RXO2266iGvt8/8obl3eHM9NPcOzb1fRFmH5t5BPYfm3qG5d2juHZp7v7SM/sfmXl6OWri1jUQw7qrsvG/mC+RB0eLCftsMS+dwQNdrLPautMgyHP6egsa6exTQBdOcjbG6HIyyoChisaK+gRUN6XtfbNT6uDHCRerr4UqzIQsKi1YUQWLvxZar++5lr08DOs57kXMVo41mS+xTsiUNKQrH9TVxBd8xw/E1FUxOUzZFvF8Xa2+WYhTKhfuNK9zzL8ismJKrkpe7Fb2ngv+R2J0Gf2KJ9QlWf23gfuaHBnlsCzSe3SjLsn8A10MGxQ==",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:"eJztWG1vGjkQ/iuuK52u0fKSJpVOq9OptEU91LygQtQPgFKzO4AbY29tLwSh/e+nsXdhWdIkp+ZyqkQ+BLCfsecZPzvemTW1bGpoOKBfYDxT6oaOAhqDiTRPLFeShrQ/A2LYAojSJE1iZoHkWNLqdggTQi3JSqXEKo9b5rOpFmQ549GMcENSAzEirObTKWgCC5DWDOXLly/z7+FQDuVxnRwdLTgsIQ6PjoaSEEJq5MsMJDF8KkETP0liFaVzkJbYGTd+BbLkQhQb1L3t169f/Ze1/8C/IXXwIQ3JkPrlhjQoz0+4AD/94fL91Xn7on999fmsApJsXgVdtM7bVZSyOaorgBkgGnBLwmTsGHn/CzYV49JB+DUq8z4kBucG2/EdslVfe52PF+3P+57mgZkzLnaA7fNW5+wOZDJTcnfJ7t+XF+0hLQOz7Y/RjuM+6u9WD2xVAFv5YfU75+1ev3XeraAiDczeCStQ2VC+RmnlyKq2NmrihuSQnxVWvsxBWc+rrEdJwUHlCQrCEb1XDx5BxqsiA/2kMPx6lXir8TeIbCce0rB06p0PZdYH9TyZekpmoz3HfzrdZKiuU5du1DwR8EDC2QqMCZGLzDygskfkn2LrQwb6bzT0wwxUBP5Jbi0HlW9QTDFEgj+QrArM06WrYsWDjJ5XRkXcH/GSVECfRHA0oCoBzTCinZiGFN/pf/Mv/kWNEFAN31Mw9p2KVzRcVyqGrlYLHoMrAKzKX6jI1jhS0oK0aMiSRPDIbdb4ZtB6TU00gznDb7gL1xBjfXKlBdYmdpUADfP7kgY00eit5WDQINUCP3KQsZrLKQ3oROk5s+URuGX4lNKQzqxNTNhorFSqa3npUku1eJtD6pGa0ywLqOXWGeSY6zFyzzKc0mASJY334XWzuR+SXhpFYMwkFWQT3X8TiftpazCpsHcx3/IsajZ/kjExG4/E6sUOQS5RTdcFqevXzeb1HznT0+bxPrkvpYKPCQ0sXhG45caaF0/HEbRW+pEU7/DjPoKnzePr5Ybg6T7BKwOaSGXJRKUyfl5S1b3vJ3K6ofFmn0ZHLpjgsSvb++oG5PMyKW9v/fbo6u3cPbOYfx0lB3LzdIdqedyTNBClmtsVDQdreltjCa/5+XAwykYBnYOdKUxhiTLOY2ZnNKSN5SYTGdAL0MYt4HLHJh0Yy6ZcTmssSeoqAYn3iGBjg+mgwRLeWBxT3KPwoYdx8qHY8WQTEJbwT7CiQUG0jAoox/OZAYtBu6Bg+D9vc2y7CGLVzfuzFq47Uc6JPIyXCcge3ql4CItjut/s4QbfI3C6uHGdIMhEaVKxJmOGXR2FNzS4SRw/qR8Tk0DEJ7mW6gQ7Oz01B+wCYQoUXN5gv6dGBpeTCY84E3g9GG5h9HtBbblc7kX+lbP5yO0sHRMNidrCp27QHU/ZavPjFQ2oBT03l5Me6AWPiuT/g60aDtzInxAWuSfEXf40LIbeVo0w5IJHIA2UNN362D0jJ/UmDUqn9wiXG2ed9+2LXhtXRZn6IzquN+tNHEJVz5ksbdTL23RXO2266iGvt8/8obl3eHM9NPcOzb1fRFmH5t5BPYfm3qG5d2juHZp7v7SM/sfmXl6OWri1jUQw7qrsvG/mC+RB0eLCftsMS+dwQNdrLPautMgyHP6egsa6exTQBdOcjbG6HIyyoChisaK+gRUN6XtfbNT6uDHCRerr4UqzIQsKi1YUQWLvxZar++5lr08DOs57kXMVo41mS+xTsiUNKQrH9TVxBd8xw/E1FUxOUzZFvF8Xa2+WYhTKhfuNK9zzL8ismJKrkpe7Fb2ngv+R2J0Gf2KJ9QlWf23gfuaHBnlsCzSe3SjLsn8A10MGxQ==",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 b(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:n}=s;return n||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)(d(),{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.h3,{id:"events",children:"events:"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"viewed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "viewed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"created:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "created",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"signed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "signed",\n "objectId":"DOCUMENT_ID"\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n ]\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"completed:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "completed",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.strong,{children:"declined:"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:'{\n "event": "declined",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signers": [\n {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n }\n ],\n "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n }\n\n'})}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(n,{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 url to create Webhook"})})}),(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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{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)(t.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:"Webhook url already exists!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{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:"Webhook url already exists!"}})})]})}),(0,l.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(t.Z,{responseExample:'{\n "error": "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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{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)(t.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(n,{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)(t.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,a.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