WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 13:17:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
8823d8be827bbb01d1cccfb659d8ab5918acf883
OpenSign/assets/js/70853c19.db466139.js
T

1 line
12 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:()=>I,contentTitle:()=>g,default:()=>T,frontMatter:()=>u,metadata:()=>i,toc:()=>M});const i=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":"eJztWetuGzcWfpUTBtjdBmPJTl1goV9VHW1WqC+CJSNYWIJDzRzNsOaQU5IjWRD0b59kH22fZHHImbEkO0pzQdot9EcX8lz4nRvJwxVzPLWsc8ve4TTT+p5NIpagjY0onNCKddgoQ7B8jqANlEXCHUJFC91BH7iUemFhqUtwOhByWFQEN9fnsMhEnIGwUFpMiMYZkaZoAOeonG2N1Vi9fPkSev5vh/6+enXSgrnABSadV6/G6gjeZaiAgxWpQuOnLHBIdFzmqFwELhM2CISFkLLW0Rqr9+/fj9VqrADGzBOMWQfGLEgfsyjMuGWBYeLN1dnNRe9ydDf616DXzOvpLxi7frJD03/TUMyE3JVwc33eTCue705fdi8eFSjtqvmBRG4RDNISgavEow4Ia8ANWzCIJc5bGgFYha9tncP+28ve9abGQIE5F3KLpHfR7Z9v0RSZVttiBv+8uuyNWSBZ09ekWk6w6k/LD4qsSbqVG0b9i95w1L0YNPOxQe6eJRirdeVOipDXLahIt0OkNhFFXEXwGeFRcR7i4+vGx29x7j5PgsuMLtMMXIaQGD5z4DAvJBWl7qB/cPTv4ugNmtJsSOlfvg3QPzMSKM2/b4WivyfLwzxMl80G8RlxEIT8ScKAGCv3f8z5H3f9RzJ8van5K9T10xbEOi8k7q3sGz6XsvK6/Zz0r1X9STz/x6n0aJyYiZjXYM5616P+P/pn3VFvyxyNB748dH5oQYKxFHurRU3xhfWiFnOIm68bN7Vd954ha6IvCxkWMV2g4XTP6Sesw+jy8pdwxalvQxEz+GuJ1v2kkyXrrHbuRgOj5yJBKI2km03QCo/MsVYOlSNGXhSS0kFo1f7FEveK2TjDnNMv0iIMJnQTuzGSbmEUUKxTxQ2LWGFotU6gJYbSSPqqiKwzQqUsYjNtcu42R/CBU4KxDsucK2yn3V7q0hxVN7Sj0sgfK5JWrHO2XkfMCecZKpq7KWFfr2nKoC20smENr4+Pn5pkWMYxWjsrJTTW/RRL7Idt0JbSPYf8EWd9Ow2eTMA2K5LLF1sAhaIwuqtB3b0+Pr77e4X09FlwOkeXCZXCwpcKo1UaQRHyzZkl8JQLBXQeNS++Hmo0Rpv9oD9tZfuMcHp8fHfSGOHkqREa+xoJXBrkyRLwQVhnvy3kfevYD/DkbtEAPH0K8MaiAaUdzHSpkm8Lalf3fiCnDYwfnsLoqzmXIvFdmpG+R/VtkWyqd0E9LfUh94WLdhYPyRP5ebYFdXM8gLQYl0a4JevcrtjDES/EUZjv3E7Wk4hRAmiq44W2fsXcZazD2oumHFs0czTWC/AFtKmJlqtkqh9aukBFO6LkU0v1sM0L0Z6fsHW0y8GL4hOoreOpUOnRXq7JI8Yh+SGYegtpY3BeiJ9xyaLakJtUERPk/wx5gsYbndx7/biR9Won7S5z/9ZAcmfaL6Jy01WBakhnC3Ly/ITt9g7foYx1jr7rlyHU5P/99388R30Y8TH4Aq5KA4VeoKHNg44tM4kPYirxuUYj8lyitXIJQjlMDW28iUiF4+E+QKUw5gWfCikoaolME7eBjcC3LTojugwNTf3VUPMywTlKCnaQWt+THKeBl07nXkd9llxocz+jJUXAYVpaodBasIg1C6qMqxih9mlEHVSuAJVDUxhhEbjIiXimDeBsJmJBgilFDY8d5FzxFEODk9ZNVijCicOC0dPSOrBalh4IacwRXYCoEBPbgjdijgE4DSbouJCYQFqSiAhinSBULiYYKoEpWgcFqRcxeqHWceNA4hyNj2HvSdpModBUSgSXoGdbviVBznBl6TgSFlS7pjFfYTTtyl5HwpctoDM87WLUJ6YAkELdUzv4CG6bMHuHUyscTv5WB+xisXiST99t87wVLiunYLDQj3ypH/TZt8ne/PmORcyhye3VbIhmLuL6APUBnW1P3K4KLI99gfVn45CrP+4yUDZJEaOyuFEOu28H5zCH71vHLNpIzd+w4PZ5/6x3OeyRXKpxIf9OWsetYxqikphztaFqWLX0b7Za+rsZvHrcMA4PAYdr3OEh4BAfh4eAg6MPDwH/H2FweAg4PAT83pX+8BBwiJs//ENA1VVx+ODaheTCN6OqHnvoI93W7XDqzWfUYercstVqyi3eGLle0/CvJRpqT00iNudG8Ck1SW4n66juxVDj6R6XrMPOwrXqaESKiVyWoa2z05OjVlLg6MYxFm4v7WYTbHA1HLGITat3i1wnxGP4gt40+IJ1mH//8L0D31mnsRWTXKUlT4k2yKT2ES/JApu9p3vfe6p+EKp6Si03VrjdlAow6JNAPcuwWoW+1nrd0IepD3JUhq2pyXGT9Xr9P4lageE=","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),s=t(28453),a=t(33617),r=t.n(a),d=t(17543),l=t.n(d),c=t(86013),p=t.n(c),h=t(63723),E=t.n(h),v=(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:"eJztWetuGzcWfpUTBtjdBmPJTl1goV9VHW1WqC+CJSNYWIJDzRzNsOaQU5IjWRD0b59kH22fZHHImbEkO0pzQdot9EcX8lz4nRvJwxVzPLWsc8ve4TTT+p5NIpagjY0onNCKddgoQ7B8jqANlEXCHUJFC91BH7iUemFhqUtwOhByWFQEN9fnsMhEnIGwUFpMiMYZkaZoAOeonG2N1Vi9fPkSev5vh/6+enXSgrnABSadV6/G6gjeZaiAgxWpQuOnLHBIdFzmqFwELhM2CISFkLLW0Rqr9+/fj9VqrADGzBOMWQfGLEgfsyjMuGWBYeLN1dnNRe9ydDf616DXzOvpLxi7frJD03/TUMyE3JVwc33eTCue705fdi8eFSjtqvmBRG4RDNISgavEow4Ia8ANWzCIJc5bGgFYha9tncP+28ve9abGQIE5F3KLpHfR7Z9v0RSZVttiBv+8uuyNWSBZ09ekWk6w6k/LD4qsSbqVG0b9i95w1L0YNPOxQe6eJRirdeVOipDXLahIt0OkNhFFXEXwGeFRcR7i4+vGx29x7j5PgsuMLtMMXIaQGD5z4DAvJBWl7qB/cPTv4ugNmtJsSOlfvg3QPzMSKM2/b4WivyfLwzxMl80G8RlxEIT8ScKAGCv3f8z5H3f9RzJ8van5K9T10xbEOi8k7q3sGz6XsvK6/Zz0r1X9STz/x6n0aJyYiZjXYM5616P+P/pn3VFvyxyNB748dH5oQYKxFHurRU3xhfWiFnOIm68bN7Vd954ha6IvCxkWMV2g4XTP6Sesw+jy8pdwxalvQxEz+GuJ1v2kkyXrrHbuRgOj5yJBKI2km03QCo/MsVYOlSNGXhSS0kFo1f7FEveK2TjDnNMv0iIMJnQTuzGSbmEUUKxTxQ2LWGFotU6gJYbSSPqqiKwzQqUsYjNtcu42R/CBU4KxDsucK2yn3V7q0hxVN7Sj0sgfK5JWrHO2XkfMCecZKpq7KWFfr2nKoC20smENr4+Pn5pkWMYxWjsrJTTW/RRL7Idt0JbSPYf8EWd9Ow2eTMA2K5LLF1sAhaIwuqtB3b0+Pr77e4X09FlwOkeXCZXCwpcKo1UaQRHyzZkl8JQLBXQeNS++Hmo0Rpv9oD9tZfuMcHp8fHfSGOHkqREa+xoJXBrkyRLwQVhnvy3kfevYD/DkbtEAPH0K8MaiAaUdzHSpkm8Lalf3fiCnDYwfnsLoqzmXIvFdmpG+R/VtkWyqd0E9LfUh94WLdhYPyRP5ebYFdXM8gLQYl0a4JevcrtjDES/EUZjv3E7Wk4hRAmiq44W2fsXcZazD2oumHFs0czTWC/AFtKmJlqtkqh9aukBFO6LkU0v1sM0L0Z6fsHW0y8GL4hOoreOpUOnRXq7JI8Yh+SGYegtpY3BeiJ9xyaLakJtUERPk/wx5gsYbndx7/biR9Won7S5z/9ZAcmfaL6Jy01WBakhnC3Ly/ITt9g7foYx1jr7rlyHU5P/99388R30Y8TH4Aq5KA4VeoKHNg44tM4kPYirxuUYj8lyitXIJQjlMDW28iUiF4+E+QKUw5gWfCikoaolME7eBjcC3LTojugwNTf3VUPMywTlKCnaQWt+THKeBl07nXkd9llxocz+jJUXAYVpaodBasIg1C6qMqxih9mlEHVSuAJVDUxhhEbjIiXimDeBsJmJBgilFDY8d5FzxFEODk9ZNVijCicOC0dPSOrBalh4IacwRXYCoEBPbgjdijgE4DSbouJCYQFqSiAhinSBULiYYKoEpWgcFqRcxeqHWceNA4hyNj2HvSdpModBUSgSXoGdbviVBznBl6TgSFlS7pjFfYTTtyl5HwpctoDM87WLUJ6YAkELdUzv4CG6bMHuHUyscTv5WB+xisXiST99t87wVLiunYLDQj3ypH/TZt8ne/PmORcyhye3VbIhmLuL6APUBnW1P3K4KLI99gfVn45CrP+4yUDZJEaOyuFEOu28H5zCH71vHLNpIzd+w4PZ5/6x3OeyRXKpxIf9OWsetYxqikphztaFqWLX0b7Za+rsZvHrcMA4PAYdr3OEh4BAfh4eAg6MPDwH/H2FweAg4PAT83pX+8BBwiJs//ENA1VVx+ODaheTCN6OqHnvoI93W7XDqzWfUYercstVqyi3eGLle0/CvJRpqT00iNudG8Ck1SW4n66juxVDj6R6XrMPOwrXqaESKiVyWoa2z05OjVlLg6MYxFm4v7WYTbHA1HLGITat3i1wnxGP4gt40+IJ1mH//8L0D31mnsRWTXKUlT4k2yKT2ES/JApu9p3vfe6p+EKp6Si03VrjdlAow6JNAPcuwWoW+1nrd0IepD3JUhq2pyXGT9Xr9P4lageE=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,I={},M=[{value:"Events:",id:"events",level:3}];function x(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(v.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,o.jsx)(r(),{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 "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 "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 "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 "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 "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 "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)(v.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(l(),{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 T(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink