WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3efd4c315e7f593762964008cf3b6be79d72ccb2
OpenSign/assets/js/d5380080.64c97fde.js
T

1 line
14 KiB
JavaScript
Raw Blame History

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[603],{62727(e,n,t){t.r(n),t.d(n,{assets:()=>j,contentTitle:()=>k,default:()=>M,frontMatter:()=>N,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1.2/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/v1.2/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/save-update-webhook","permalink":"/docs/API-docs/v1.2/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":"eJztGdtuG7fyV6YM0NMs1pKdpsCB+lI31XGF4xssGcGBZTjU7kjLmktuSa5kQRDQh/MH5+m89tPyJcWQu6uLE+VWBEGgF1tLzgznxuFcFszxiWWdG/YSR5nW9+w2ZinaxIjCCa1Yhw0yBMunCNpAWaTcIVSwcHzZAy6lnlmY6xKcDoAcZhXA9dUpzDKRZCAslBZTgnFGTCZoAKeonG0N1VA9efIEuv6zQ59RdNSCqcAZpp0oGqoDeJmhAg5WTBQav2WBQ6qTMkflYnCZsIEgzISU9RmtoXr16tVQLYYKYMg8wJB1YMgC9SGLw46bFxg2frl4cX3WPR/cDf5z2W329eg3TFwv3YLp/dJAjIXcpnB9ddpsK55vb58fn60OUNpV+5cSuUUwSCwCV6mXOkhYC9ygrZkqYDc7QVWWVm9oBWAR/m1y0++dnHev1nkJEJhzITdAumfHvdMNmCLTapPM5a8X590hCyBL+ndbsRP0/fP8rSRrkOPKQIPeWbc/OD67bPYTg9y9EWColpWhyXeetaAC3XSeWnnkixXARzhOhbn3nM/lOe9j9l02BpcZXU4ycBlCavjYgcO8kBTIji97exf4wlxgDaY0a1R65ydBKR/pIxQavm+FJ2RHZAj7MJo3z81HeEgg8tU7CC1WjvEut3i3U7wjKizXT/4bXonnLUh0Xkjc+U6seYOUlT/YjwkZ9VFfvU98Oe8GGifGIuG1mC+6V4Pev3ovjgfdDUU1tvl0p/qhBSkmUuyMMDXEJ8aYmszeoz6XR9Ua35nF1kCf5kwsZrpAw0kpvZR1GBVW34byq67UYmbw9xKt+1mnc9ZZbNVtl0ZPRYpQGklVVzgVVsiJVg6VI0ReFJIuitCq/Zsl7AWzSYY5p190ijCYUpV4bSRViORqrFN5FItZYYhbJ9ASQmkk/auArDNCTVjMxtrk3K2v4AOnq8c6LHOusJ12e65Lc1BVjwelkT9VIK1E52y5jJkTziNUMHcjkn25pC2DttDKBh6eHR4+Vkm/TBK0dlxKaLT7IZrYLbZBW0r3JslXctaVc7BkCrbhSM6/2RBQKHKju1qou2eHh3f/rCR9/kbhdI4uE2oCMx9EjFaTGIpwE52ZA59woYDyXvPN3yc1GqPNbqE/jLNdSnh+eHh31Cjh6LESGv0aCVwa5Okc8EFYZz+vyLv42C3g0d2sEfD5YwGvLRpQ2sFYlyr9vEJtn71bkOeNGD88FqOnplyK1HeQBvoe1eeVZP14F44nVh9yH7joZfEieSC/zzZEXV8PQlpMSiPcnHVuFuzhgBfiIOx3bm6XtzGjC6Apjhfaeo65y1iHtWdNOLZopmisJ+ADaBMTLVfpSD+0dIGKXkTJR5biYZsXoj09aj1jy3gbhxfFB8FjefChKNbxiVCTd+HdrpTTJwMGG22oqLEUL8S/cc7i2gLrUDET5DgZ8hSNtxb5xdXqBezW1t1mdPebQnTH2jNR2feiQNWndIW8wwux3RJ9iTLROfpmZoYQRTXK6//+2WBFUZPqeD/2jc6L0kChZ2joDaK8aCzxQYykb0UA5n5v1U1Fnku0Vs5BKIcTQy94KibC8VCMUExNeMFHQgpyfwLThG1g7QbZFqWhLkNDW/8w1KFNcYqSbg3w0umcOyLVZKkzbe7H1NeNgcOotEKhtYAq4yohwNqiMTWFuQJUDk1hhEWwzhDXIvCmlTM8cZBzxScYerXrykpRCnJ7MHpUWgdWy9KzDI4LqU3oGHuBFGIausXdh4K2gFYpeTeYkftNESalSNHGkOiUmtZkZRJBpTBC66AgXkSCloiWSurk3huQnl8oNAUfwSXo8QaPhO4MV5YSmMBLbYNGYYXR9I5jYDCKri2ShU+FurdVJXDT+NVLHFnh8Pa72kNns9mjK/R0E+dEuF/LEVxhoa1w2sxX2BPhsnLkr906keYjUDpBhd5/1i7VikaqE/v4FtNqO0NZtPvoyENs+/iy5+P1U3j9x//gFLlRkOlZ8NakNCjnMKmPIs0Fywe1NeEWxto7XkYaT4LzVclsrcGXGXev//i/hXOcgVDVlSJRougEHQzqHt63sPF5KqyLog4YzPUUUyiVQjINN3MouOE5OvI3X5MgLVAaVhgcU9GVcsdhbHReTxpWGC06OpRIdwW3dqZNOmQrAOBpiilxWmXadZMxrqcmq4UKYnXdhMvWtkOTstkNrMpxqKGMLl1w4KJK8GtuvFILox0mXqZ0XDPtZzR3ejz2bzSReS/O/clbzK+d76nSVMf4T1Sc4pim22HDz3BgE6mIP5ehMA21msGg7Tujqf58E2d0S6tqEMKzT7d0U1GP9PpORT+yFAlclCMpkm2BW3CcJFiQYqdclmg7EEWBoyiC71Ic81K6pzFEkZ9jmCii37wgK9FXC/oV/zkFuswPyhxQEuxAV1rirjQIM5FO0P0YJmAbCEpXm/ZHqElbyPm8oqfm9b4XVZeu6jAEwlUlR6po+Rpz6xnefOUMjtGQ7rx5V5e6ENUlvqmDAVCM+JRgQs8wvRU88dmfL9xDPvDTNh2fiaHJ7cW4j2Yqkrp8fEscbXvgNouZFAkqi2sZ3vHJ5SlMv28dsngtZ3iPkNo+7b3onve7xAyZICjsqHXYOqQlSvJyrtZO6lcD1OuNAep2YrFYpcD7seu+ZbUfu+5nbvux694F9mPX/dh1P3bdj12/vKCxH7vuPeorG7tWrWiHD65dSC5867+aaIau/U09fKRJaEb9/M4NWyxG3OK1kcslLf9eoqFhwG3MptwIaof4UUBcN7CpzX+Pc9ZhL0LJdzCggwlclqEXvjUBoQ58wAidiJ2w6yOHy4v+gMVsVE2Jc50SjuEzmiDzGeswP232bVc/x6S1BZNcTUo+IdhAk3ru1LPbbNjf+4Z99YOkqrfUfI3DzU5+EIP+klBvRFgswjBguWzgw9ZbMSrF1tBkuNvlcvkXUcCkew==","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.2/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.2/delete-webhook"}}');var s=t(74848),o=t(28453),r=t(57742),d=t.n(r),c=t(78178),l=t.n(c),a=t(19624),p=t.n(a),h=t(96226),E=t.n(h),u=(t(77675),t(19365),t(51107)),g=t(21312);const N={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:"eJztGdtuG7fyV6YM0NMs1pKdpsCB+lI31XGF4xssGcGBZTjU7kjLmktuSa5kQRDQh/MH5+m89tPyJcWQu6uLE+VWBEGgF1tLzgznxuFcFszxiWWdG/YSR5nW9+w2ZinaxIjCCa1Yhw0yBMunCNpAWaTcIVSwcHzZAy6lnlmY6xKcDoAcZhXA9dUpzDKRZCAslBZTgnFGTCZoAKeonG0N1VA9efIEuv6zQ59RdNSCqcAZpp0oGqoDeJmhAg5WTBQav2WBQ6qTMkflYnCZsIEgzISU9RmtoXr16tVQLYYKYMg8wJB1YMgC9SGLw46bFxg2frl4cX3WPR/cDf5z2W329eg3TFwv3YLp/dJAjIXcpnB9ddpsK55vb58fn60OUNpV+5cSuUUwSCwCV6mXOkhYC9ygrZkqYDc7QVWWVm9oBWAR/m1y0++dnHev1nkJEJhzITdAumfHvdMNmCLTapPM5a8X590hCyBL+ndbsRP0/fP8rSRrkOPKQIPeWbc/OD67bPYTg9y9EWColpWhyXeetaAC3XSeWnnkixXARzhOhbn3nM/lOe9j9l02BpcZXU4ycBlCavjYgcO8kBTIji97exf4wlxgDaY0a1R65ydBKR/pIxQavm+FJ2RHZAj7MJo3z81HeEgg8tU7CC1WjvEut3i3U7wjKizXT/4bXonnLUh0Xkjc+U6seYOUlT/YjwkZ9VFfvU98Oe8GGifGIuG1mC+6V4Pev3ovjgfdDUU1tvl0p/qhBSkmUuyMMDXEJ8aYmszeoz6XR9Ua35nF1kCf5kwsZrpAw0kpvZR1GBVW34byq67UYmbw9xKt+1mnc9ZZbNVtl0ZPRYpQGklVVzgVVsiJVg6VI0ReFJIuitCq/Zsl7AWzSYY5p190ijCYUpV4bSRViORqrFN5FItZYYhbJ9ASQmkk/auArDNCTVjMxtrk3K2v4AOnq8c6LHOusJ12e65Lc1BVjwelkT9VIK1E52y5jJkTziNUMHcjkn25pC2DttDKBh6eHR4+Vkm/TBK0dlxKaLT7IZrYLbZBW0r3JslXctaVc7BkCrbhSM6/2RBQKHKju1qou2eHh3f/rCR9/kbhdI4uE2oCMx9EjFaTGIpwE52ZA59woYDyXvPN3yc1GqPNbqE/jLNdSnh+eHh31Cjh6LESGv0aCVwa5Okc8EFYZz+vyLv42C3g0d2sEfD5YwGvLRpQ2sFYlyr9vEJtn71bkOeNGD88FqOnplyK1HeQBvoe1eeVZP14F44nVh9yH7joZfEieSC/zzZEXV8PQlpMSiPcnHVuFuzhgBfiIOx3bm6XtzGjC6Apjhfaeo65y1iHtWdNOLZopmisJ+ADaBMTLVfpSD+0dIGKXkTJR5biYZsXoj09aj1jy3gbhxfFB8FjefChKNbxiVCTd+HdrpTTJwMGG22oqLEUL8S/cc7i2gLrUDET5DgZ8hSNtxb5xdXqBezW1t1mdPebQnTH2jNR2feiQNWndIW8wwux3RJ9iTLROfpmZoYQRTXK6//+2WBFUZPqeD/2jc6L0kChZ2joDaK8aCzxQYykb0UA5n5v1U1Fnku0Vs5BKIcTQy94KibC8VCMUExNeMFHQgpyfwLThG1g7QbZFqWhLkNDW/8w1KFNcYqSbg3w0umcOyLVZKkzbe7H1NeNgcOotEKhtYAq4yohwNqiMTWFuQJUDk1hhEWwzhDXIvCmlTM8cZBzxScYerXrykpRCnJ7MHpUWgdWy9KzDI4LqU3oGHuBFGIausXdh4K2gFYpeTeYkftNESalSNHGkOiUmtZkZRJBpTBC66AgXkSCloiWSurk3huQnl8oNAUfwSXo8QaPhO4MV5YSmMBLbYNGYYXR9I5jYDCKri2ShU+FurdVJXDT+NVLHFnh8Pa72kNns9mjK/R0E+dEuF/LEVxhoa1w2sxX2BPhsnLkr906keYjUDpBhd5/1i7VikaqE/v4FtNqO0NZtPvoyENs+/iy5+P1U3j9x//gFLlRkOlZ8NakNCjnMKmPIs0Fywe1NeEWxto7XkYaT4LzVclsrcGXGXev//i/hXOcgVDVlSJRougEHQzqHt63sPF5KqyLog4YzPUUUyiVQjINN3MouOE5OvI3X5MgLVAaVhgcU9GVcsdhbHReTxpWGC06OpRIdwW3dqZNOmQrAOBpiilxWmXadZMxrqcmq4UKYnXdhMvWtkOTstkNrMpxqKGMLl1w4KJK8GtuvFILox0mXqZ0XDPtZzR3ejz2bzSReS/O/clbzK+d76nSVMf4T1Sc4pim22HDz3BgE6mIP5ehMA21msGg7Tujqf58E2d0S6tqEMKzT7d0U1GP9PpORT+yFAlclCMpkm2BW3CcJFiQYqdclmg7EEWBoyiC71Ic81K6pzFEkZ9jmCii37wgK9FXC/oV/zkFuswPyhxQEuxAV1rirjQIM5FO0P0YJmAbCEpXm/ZHqElbyPm8oqfm9b4XVZeu6jAEwlUlR6po+Rpz6xnefOUMjtGQ7rx5V5e6ENUlvqmDAVCM+JRgQs8wvRU88dmfL9xDPvDTNh2fiaHJ7cW4j2Yqkrp8fEscbXvgNouZFAkqi2sZ3vHJ5SlMv28dsngtZ3iPkNo+7b3onve7xAyZICjsqHXYOqQlSvJyrtZO6lcD1OuNAep2YrFYpcD7seu+ZbUfu+5nbvux694F9mPX/dh1P3bdj12/vKCxH7vuPeorG7tWrWiHD65dSC5867+aaIau/U09fKRJaEb9/M4NWyxG3OK1kcslLf9eoqFhwG3MptwIaof4UUBcN7CpzX+Pc9ZhL0LJdzCggwlclqEXvjUBoQ58wAidiJ2w6yOHy4v+gMVsVE2Jc50SjuEzmiDzGeswP232bVc/x6S1BZNcTUo+IdhAk3ru1LPbbNjf+4Z99YOkqrfUfI3DzU5+EIP+klBvRFgswjBguWzgw9ZbMSrF1tBkuNvlcvkXUcCkew==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},k=void 0,j={},v=[{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,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(d(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,s.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,s.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(l(),{parameters:void 0}),"\n",(0,s.jsx)(p(),{...t(93764)}),"\n",(0,s.jsx)(E(),{...t(1790)})]})}function M(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(m,{...e})}):m(e)}},93764(e){e.exports=JSON.parse('{"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"}}}}}')},1790(e){e.exports=JSON.parse('{"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"}}}}}}')}}]);
Reference in New Issue View Git Blame Copy Permalink