WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-26 17:42:33 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
dffbb1319e4e6eb1db319604ddca47c55c61ecf9
OpenSign/assets/js/70853c19.b02fe1ab.js
T

1 line
13 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3451],{47561:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>b,contentTitle:()=>M,default:()=>I,frontMatter:()=>u,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"API-docs/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a 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":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar_label":"Save or Update Webhook","hide_title":true,"hide_table_of_contents":true,"api":"eJztWf1uIjkSf5Uaj3R3G3Ugmc1KJ/5aNstl0eUDBaLRCaKM6S5ob4zda7shCCHdH/cG9wb3aPskp7K7m4bMMDszq2g04h8+XFV2ffxcZZdXzPGpZa0he4vjVOtHdh+xBG1sROaEVqzFBimC5XMEbSDPEu4QCl5o97rApdQLC0udg9OBkcOiYLi7vYRFKuIUhIXcYkI8zojpFA3gHJWzjZEaqdevX0PH/23R36Oj0wbMBS4waR0djdQxvE1RAQcrpgqNJ1ngkOg4n6FyEbhU2DAhLISU5RqNkXr37t1IrUYKYMQ8w4i1YMTC7CMWBYpbZhgIP9+c3111rgcPg3/1OhVdj3/F2HWTHZ7uzxXHRMjdGe5uLyuy4rNd8nX7arOA0q6g9yRyi2CQVASuEm91sLA0uBKrhSpIV5TgKkujQxoBWIWvbW363Yvrzm1dl8CBMy7kFkvnqt293OLJUq22p+n9cnPdGbHAsqav+0Kd4O+flh+csmRpFwEadK86/UH7qlfRY4PcvZdhpNZFoAk7bxpQsG6Dp3QeYbFg+AzgFJIH5LwUcv5I2PfFGFxqdD5NwaUIieETBw5nmaRE1u51DxD4yiBQ48lNbZbu9UVwymdihFLD941QQvZkhkCH8bIqN5+BkDDJNw8QGiyA8TFYfBwUH8kK6/rKf0KVOGtArGeZxL11ooYGKQs82M9JGeVS3zwmvp66gcaJiYh5aeZ553bQ/Uf3vD3obDmqis2Xg+qHBiQYS7E3w5QcX5hjymkOiHopRJUe33uKLZm+DEwsYjpDw8kp3YS1GF2s/hKuX+VNLWIGf8vRup90smSt1c69rWf0XCQIuZF06wqrwkY41sqhciTIs0zSRhFaNX+1JL1iNk5xxukXrSIMJnRLvDOSbogENdYqEMUilhnS1gm0JJAbSV8Fk3VGqCmL2ESbGXf1EXzitPVYi6XOZbbVbC51bo6L2+NxbuSPBUsj1jO2XkfMCecFCp6HMdm+XhPJoM20skGHNycnz13Sz+MYrZ3kEirvfoon9ptt0ObSvc/yjZ3lzTlEMgFbaSSXr7YMFIpg9FAa9fDm5OTh74WlZ+81Ts/QpUJNYeGTiNFqGkEWdqIzS+BTLhTQude8+vOsRmO02W/0p2m2zwlnJycPp5UTTp87ofKvkcClQZ4sAZ+EdfZlTd6nx34DTx8WlYFnzw28s2hAaQcTnavkZY3aXXu/IWeVGT88N6Or5lyKxHeQBvoR1ctaUl/eheVJ1aeZT1xUWbxJnsnT2Zap9fFgpMU4N8ItWWu4Yk/HPBPHgd4a3q/vI0YbQFMez7T1GnOXshZrLqp0bNHM0Vg/gU+gVU60XCVj/dTQGSqqiJKPLeXDJs9Ec37K1tGuBM+yT+DG/PjTBKzjU6Gm+6XuN07pU+BCbLZcU0WIZ+KfuGRR6fk6V8QEASZFnqDxUSI83G4qX6eM6q6a+2sJzTvRXokirjcZqj4dUwgV81O22wh9izLWM/QtzBShZP/9P//zEuW5xoP2FZ0Hb3IDmV6goYJDh6CJxCcxlr7vADjztE3rFPlMorVyCUI5nBoq14mYCsfDzYMSaMwzPhZSENaJTZO0gdp2sQ06c7oUDZH+aqgdm+AcJW0R4LnTM+5oqupIutDmcUJN3Ag4jHMrFFoLqFKuYmIswxhRB5grQOXQZEZYBOsMaS2Cblo5w2MHM674FENjtu6lBKUgjIPR49w6sFrmXmVwXEhtQnvYG6QQk9Aa7jxlRAIapZO6wZQQN0eY5iJBG0GsE+pQU2jJBJXAGK2DjHQRMVqaNFdSx48+blRrIdOUaQSXoCdbOpK4M1xZOq0EXcoYVA7LjKaijUHBo6M7ixThS6EebXHsH1ZgeotjKxze/62E5WKxeLZrvtuWuRDul3wMt5hpK5w2y430VLg0H/udVp+k+hNmukCFHj+1nbSZI9Gxfb5xabSZosyafXSEENts97o+OX8Hv//7v3CJ3ChI9SKgNc4NyiVMy6XIcyHywW1VboWJ9sBLyeNxAF9xciUPsmg3K2xvO4MTNOR8H8jNcpkoph+WagJp/yVmUlYgFPPYFyF/fwjp6cfdeXxBQDOzN5M+mrmIy1PsByLc9MxNFjEpYlQWa4WmfdG7hDl83zhhUS2H/YFoNy+7553rfoe0oZ0VPHbaOGmc0BAVmxlXtaX6xUPO3dZDzm6qW21K8eH553B1Pjz/HHr/h+efAwQOzz+H55/D88/h+efrSxqH558Dor6x55+iNebwyTUzyYVvQRYvK6F7OCwfQehFJqW+YmvIVqsxt3hn5HpNw7/laKgpeR+xOTeCj6nTNbxfR2VDjdqNj7hkLXYernzHA1qY2GUeenM7nVjqBwaJdhxj5vby1lufvZv+gEVsXLxWzXRCMoYv6CWLL1iL+Vcv3xHy7yk0tmKSq2nOp8Qb5qQeILUTthuIj76BWPwgq0qSWtY03O4sBjPok4x6r8BqFZqT63XFH0gflCgcW3JT4O7X6/X/AWL2ZCo=","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"}}');var o=t(74848),i=t(28453),r=t(33617),a=t.n(r),d=t(17543),c=t.n(d),l=t(86013),p=t.n(l),h=t(63723),E=t.n(h),g=(t(18766),t(79329),t(9303));const u={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWf1uIjkSf5Uaj3R3G3Ugmc1KJ/5aNstl0eUDBaLRCaKM6S5ob4zda7shCCHdH/cG9wb3aPskp7K7m4bMMDszq2g04h8+XFV2ffxcZZdXzPGpZa0he4vjVOtHdh+xBG1sROaEVqzFBimC5XMEbSDPEu4QCl5o97rApdQLC0udg9OBkcOiYLi7vYRFKuIUhIXcYkI8zojpFA3gHJWzjZEaqdevX0PH/23R36Oj0wbMBS4waR0djdQxvE1RAQcrpgqNJ1ngkOg4n6FyEbhU2DAhLISU5RqNkXr37t1IrUYKYMQ8w4i1YMTC7CMWBYpbZhgIP9+c3111rgcPg3/1OhVdj3/F2HWTHZ7uzxXHRMjdGe5uLyuy4rNd8nX7arOA0q6g9yRyi2CQVASuEm91sLA0uBKrhSpIV5TgKkujQxoBWIWvbW363Yvrzm1dl8CBMy7kFkvnqt293OLJUq22p+n9cnPdGbHAsqav+0Kd4O+flh+csmRpFwEadK86/UH7qlfRY4PcvZdhpNZFoAk7bxpQsG6Dp3QeYbFg+AzgFJIH5LwUcv5I2PfFGFxqdD5NwaUIieETBw5nmaRE1u51DxD4yiBQ48lNbZbu9UVwymdihFLD941QQvZkhkCH8bIqN5+BkDDJNw8QGiyA8TFYfBwUH8kK6/rKf0KVOGtArGeZxL11ooYGKQs82M9JGeVS3zwmvp66gcaJiYh5aeZ553bQ/Uf3vD3obDmqis2Xg+qHBiQYS7E3w5QcX5hjymkOiHopRJUe33uKLZm+DEwsYjpDw8kp3YS1GF2s/hKuX+VNLWIGf8vRup90smSt1c69rWf0XCQIuZF06wqrwkY41sqhciTIs0zSRhFaNX+1JL1iNk5xxukXrSIMJnRLvDOSbogENdYqEMUilhnS1gm0JJAbSV8Fk3VGqCmL2ESbGXf1EXzitPVYi6XOZbbVbC51bo6L2+NxbuSPBUsj1jO2XkfMCecFCp6HMdm+XhPJoM20skGHNycnz13Sz+MYrZ3kEirvfoon9ptt0ObSvc/yjZ3lzTlEMgFbaSSXr7YMFIpg9FAa9fDm5OTh74WlZ+81Ts/QpUJNYeGTiNFqGkEWdqIzS+BTLhTQude8+vOsRmO02W/0p2m2zwlnJycPp5UTTp87ofKvkcClQZ4sAZ+EdfZlTd6nx34DTx8WlYFnzw28s2hAaQcTnavkZY3aXXu/IWeVGT88N6Or5lyKxHeQBvoR1ctaUl/eheVJ1aeZT1xUWbxJnsnT2Zap9fFgpMU4N8ItWWu4Yk/HPBPHgd4a3q/vI0YbQFMez7T1GnOXshZrLqp0bNHM0Vg/gU+gVU60XCVj/dTQGSqqiJKPLeXDJs9Ec37K1tGuBM+yT+DG/PjTBKzjU6Gm+6XuN07pU+BCbLZcU0WIZ+KfuGRR6fk6V8QEASZFnqDxUSI83G4qX6eM6q6a+2sJzTvRXokirjcZqj4dUwgV81O22wh9izLWM/QtzBShZP/9P//zEuW5xoP2FZ0Hb3IDmV6goYJDh6CJxCcxlr7vADjztE3rFPlMorVyCUI5nBoq14mYCsfDzYMSaMwzPhZSENaJTZO0gdp2sQ06c7oUDZH+aqgdm+AcJW0R4LnTM+5oqupIutDmcUJN3Ag4jHMrFFoLqFKuYmIswxhRB5grQOXQZEZYBOsMaS2Cblo5w2MHM674FENjtu6lBKUgjIPR49w6sFrmXmVwXEhtQnvYG6QQk9Aa7jxlRAIapZO6wZQQN0eY5iJBG0GsE+pQU2jJBJXAGK2DjHQRMVqaNFdSx48+blRrIdOUaQSXoCdbOpK4M1xZOq0EXcoYVA7LjKaijUHBo6M7ixThS6EebXHsH1ZgeotjKxze/62E5WKxeLZrvtuWuRDul3wMt5hpK5w2y430VLg0H/udVp+k+hNmukCFHj+1nbSZI9Gxfb5xabSZosyafXSEENts97o+OX8Hv//7v3CJ3ChI9SKgNc4NyiVMy6XIcyHywW1VboWJ9sBLyeNxAF9xciUPsmg3K2xvO4MTNOR8H8jNcpkoph+WagJp/yVmUlYgFPPYFyF/fwjp6cfdeXxBQDOzN5M+mrmIy1PsByLc9MxNFjEpYlQWa4WmfdG7hDl83zhhUS2H/YFoNy+7553rfoe0oZ0VPHbaOGmc0BAVmxlXtaX6xUPO3dZDzm6qW21K8eH553B1Pjz/HHr/h+efAwQOzz+H55/D88/h+efrSxqH558Dor6x55+iNebwyTUzyYVvQRYvK6F7OCwfQehFJqW+YmvIVqsxt3hn5HpNw7/laKgpeR+xOTeCj6nTNbxfR2VDjdqNj7hkLXYernzHA1qY2GUeenM7nVjqBwaJdhxj5vby1lufvZv+gEVsXLxWzXRCMoYv6CWLL1iL+Vcv3xHy7yk0tmKSq2nOp8Qb5qQeILUTthuIj76BWPwgq0qSWtY03O4sBjPok4x6r8BqFZqT63XFH0gflCgcW3JT4O7X6/X/AWL2ZCo=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},M=void 0,b={},x=[{value:"Events:",id:"events",level:3}];function m(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,o.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,o.jsx)(n.p,{children:"The save or update Webhook API allows you to save a webhook URL which is used to trigger events."}),"\n",(0,o.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "viewed",\n "type": "DOCUMENT_TYPE",\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 "viewedBy": "SIGNER_EMAIL",\n "viewedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\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 "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "created",\n "type": "DOCUMENT_TYPE",\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 "url": "SIGNING_URL"\n }\n ],\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "signed",\n "type": "DOCUMENT_TYPE",\n "objectId": "DOCUMENT_ID",\n "file": "DOCUMENT_URL",\n "name": "DOCUMENT_NAME",\n "note": "Please review and sign this document",\n "description": "",\n "signer": {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "completed",\n "type": "DOCUMENT_TYPE",\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 "certificate": "CERTIFICATE_URL",\n "completedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'{\n "event": "declined",\n "type": "DOCUMENT_TYPE",\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 "declinedBy": "SIGNER_EMAIL",\n "declinedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n}\n'})}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(c(),{parameters:void 0}),"\n",(0,o.jsx)(p(),{title:"Body",body:{description:"Provide url to create Webhook",content:{"application/json":{schema:{required:["Url"],type:"object",properties:{url:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}},title:"webhook_body"}}}}}),"\n",(0,o.jsx)(E(),{id:void 0,label:void 0,responses:{200:{description:"Successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"string",example:"Webhook updated successfully!"}},title:"inline_response_200_8"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},401:{description:"Webhook url already exists!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Webhook url already exists!"}},title:"inline_response_401_w"}}}},404:{description:"User not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"User not found!"}},title:"inline_response_404"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function I(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(m,{...e})}):m(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink