WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 05:07:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3611a7933feadd8e51068c4e2b4c0620ebc1a834
OpenSign/assets/js/70853c19.5d1e4741.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:()=>U,contentTitle:()=>E,default:()=>A,frontMatter:()=>g,metadata:()=>i,toc:()=>I});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":"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnCHnm/k4JIdr5nhsWfeGvcNZovUdmwYsQhsakTmhFeuycYJg+QJBG8iziDuEUhZ6wwFwKfXSwkrn4LQX5LAsBa6vzmCZiDABYSG3GJGMMyKO0QAuUDnbmqiJevnyJfSLv136++rVcQsWApcYdV+9mqgjeJegAg5WxApN0WWBQ6TDPEXlAnCJsH5AWAopqzlaE/X+/fuJWk8UwIQVAhPWhQnzo09Y4HvcKkPf8eby9Pq8fzG+Hf8x7Nf9evYnhm4Q7cgM3tQScyF3R7i+Oqu7FU93uy965w8TKO3K/qFEbhEMkonAVVSg9ggrwLVaI1Reu+7xrrLUekMtAGv/tW3NaPD2on/VtMVLYMqF3BLpn/cGZ1syWaLV9jDD3y8v+hPmRTb0NS3N8f7+dfXBISuRXhmg8eC8Pxr3zod1f2iQuycFJmpTBpq487oFpeg2eSrnERdLgc8gTql5YM5zMefvhH1fjMElRudxAi5BiAyfO3CYZpISWW84OFDgK6NAQyY3jVEGF2+9Uz6TI5Qafmr5LWRPZvD9MFvV281nMMQP8s0ThBpLYnyMFh8nxUeywqY58z+wS5y0INRpJnHvPtFgg5QlH+znpIxqqm+eE1/PvoHGibkIeQXztH81Hvw2OO2N+1uOqmPz5aT6uQURhlLszTCVxBfmmGqYA6Oei1GVx/eeYiuhLyMTC5jO0HByyiBiXUYXq+/89au6qQXM4F85Wverjlasu965tw2NXogIITeSbl1+VnhQDrVyqBwp8iyTtFCEVu0/LWmvmQ0TTDn9olmEwYhuiddG0g2RqMa6JaNYwDJD1jqBlhRyI+mrFLLOCBWzgM21SblrtuA9p6XHuixxLrPddnulc3NU3h6PciN/KUVaoU7ZZhMwJ1yhUMrczgj7ZkNdBm2mlfU2vO50HrtklIchWjvPJdTe/RRP7Idt0ObSPYX8AWd1c/aRjMDWFsnViy2AQhGNbitQt687ndt/lUhPngSnU3SJUDEsiyRitIoDyPxKdGYFPOZCAZ17zYt/DjUao81+0J9m2T4nnHQ6t8e1E44fO6H2r5HApUEerQDvhXX2eSHvs2M/wOPbZQ3w5DHAa4sGlHYw17mKnhfU7tz7gZzUMH5+DGOgFlyKqKggjfUdqudF0pze+enJ1Pu0SFy0sxSQCqGin21BbbZ7kBbD3Ai3Yt2bNbs/4pk48v3dm+lmGjBaAJryeKZtYTF3Ceuy9rJOxxbNAo0tBigSaJ0TLVfRTN+3dIaKdkTJZ5byYZtnor04ZptgV4Nn2SdIW8djoeKjvVrTB4wjioN39RbS2uE8E//GFQsqRzalAiYo/gnyCE3hdArv1cNG1q+CtGvm/q2Bxp3rwogyTJcZqhGdOijIi2O2W9d8hzLUKRYVyQShEv/ff/5baFTHlIKDL+AyN5DpJRraPOhAM5d4L2YSnyqCIk8lWitXIJTD2NDGG4lYOO7vEJQKQ57xmZCCWEtimrQNNIhvW3R6dAka6vreUGE1wgVKIjtIre9oHKeB506nxRzVKXOpzd2cTAqAwyy3QqG1YBErFVQJVyFCFdOAqrtcASqHJjPCInCRkvBcG8D5XISCBqYlanjoIOWKx+iLr2Q3eSHzJw4LRs9y68BqmRdAaMYU0XmICjGyLXgjFuiBU2OEjguJEcQ5DRFAqCOEMsQEQ0UwQ+sgo+lFiMWg1nHjQOICTcHhIpK0mUKmKZUILkHPt2JLAznDlaXjiDeoCk3tvsxo2pWLOSK+agGd7mkXoxo2EUAKdUel6iO4qWn2DmdWOJz+UBF2uVw+Wk8/buu8FS7JZ2Aw0w96cdFYrL6mev3nRxYwhya1l/MRmoUIqwPUB+ZsF8LtMsHysEiwxdnYr9VfdhVoNUkRorLYSIe9t8MzWMBPrQ4LGkvzbxjcPhuc9i9GfRqXcpxff8etTqtDTZQSU64aU43K54brreeG3RW8ftgwDo8Uhwve4ZHiUKE+PFIcKHB4pDg8UhweKQ6PFF9f0jg8UhwY9Y09UpQVH4f3rp1JLopCWVn/9zWum6pUT+8GCVW/ujdsvZ5xi9dGbjbU/FeOhkpn04AtuBF8RgWcm+kmqOpEVBS7wxXrslN/5Tsa08QkLnNfctqpF1KZy2v0whAzt1e2WaAbXo7GLGCz8k0l1RHpGL6k9xa+ZF1WvM0UdY2i6k9taya5inMek6wfk0pbPCcPNOtid0VdrPxBqKoutWpYuF0w8zDok0A9qbBe+5rbZlPL+64PapSOraQpcNPNZvN/PSfj8Q==","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),r=t(33617),d=t.n(r),a=t(17543),l=t.n(a),c=t(86013),p=t.n(c),h=t(63723),u=t.n(h),m=(t(18766),t(79329),t(9303));const g={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:"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnCHnm/k4JIdr5nhsWfeGvcNZovUdmwYsQhsakTmhFeuycYJg+QJBG8iziDuEUhZ6wwFwKfXSwkrn4LQX5LAsBa6vzmCZiDABYSG3GJGMMyKO0QAuUDnbmqiJevnyJfSLv136++rVcQsWApcYdV+9mqgjeJegAg5WxApN0WWBQ6TDPEXlAnCJsH5AWAopqzlaE/X+/fuJWk8UwIQVAhPWhQnzo09Y4HvcKkPf8eby9Pq8fzG+Hf8x7Nf9evYnhm4Q7cgM3tQScyF3R7i+Oqu7FU93uy965w8TKO3K/qFEbhEMkonAVVSg9ggrwLVaI1Reu+7xrrLUekMtAGv/tW3NaPD2on/VtMVLYMqF3BLpn/cGZ1syWaLV9jDD3y8v+hPmRTb0NS3N8f7+dfXBISuRXhmg8eC8Pxr3zod1f2iQuycFJmpTBpq487oFpeg2eSrnERdLgc8gTql5YM5zMefvhH1fjMElRudxAi5BiAyfO3CYZpISWW84OFDgK6NAQyY3jVEGF2+9Uz6TI5Qafmr5LWRPZvD9MFvV281nMMQP8s0ThBpLYnyMFh8nxUeywqY58z+wS5y0INRpJnHvPtFgg5QlH+znpIxqqm+eE1/PvoHGibkIeQXztH81Hvw2OO2N+1uOqmPz5aT6uQURhlLszTCVxBfmmGqYA6Oei1GVx/eeYiuhLyMTC5jO0HByyiBiXUYXq+/89au6qQXM4F85Wverjlasu965tw2NXogIITeSbl1+VnhQDrVyqBwp8iyTtFCEVu0/LWmvmQ0TTDn9olmEwYhuiddG0g2RqMa6JaNYwDJD1jqBlhRyI+mrFLLOCBWzgM21SblrtuA9p6XHuixxLrPddnulc3NU3h6PciN/KUVaoU7ZZhMwJ1yhUMrczgj7ZkNdBm2mlfU2vO50HrtklIchWjvPJdTe/RRP7Idt0ObSPYX8AWd1c/aRjMDWFsnViy2AQhGNbitQt687ndt/lUhPngSnU3SJUDEsiyRitIoDyPxKdGYFPOZCAZ17zYt/DjUao81+0J9m2T4nnHQ6t8e1E44fO6H2r5HApUEerQDvhXX2eSHvs2M/wOPbZQ3w5DHAa4sGlHYw17mKnhfU7tz7gZzUMH5+DGOgFlyKqKggjfUdqudF0pze+enJ1Pu0SFy0sxSQCqGin21BbbZ7kBbD3Ai3Yt2bNbs/4pk48v3dm+lmGjBaAJryeKZtYTF3Ceuy9rJOxxbNAo0tBigSaJ0TLVfRTN+3dIaKdkTJZ5byYZtnor04ZptgV4Nn2SdIW8djoeKjvVrTB4wjioN39RbS2uE8E//GFQsqRzalAiYo/gnyCE3hdArv1cNG1q+CtGvm/q2Bxp3rwogyTJcZqhGdOijIi2O2W9d8hzLUKRYVyQShEv/ff/5baFTHlIKDL+AyN5DpJRraPOhAM5d4L2YSnyqCIk8lWitXIJTD2NDGG4lYOO7vEJQKQ57xmZCCWEtimrQNNIhvW3R6dAka6vreUGE1wgVKIjtIre9oHKeB506nxRzVKXOpzd2cTAqAwyy3QqG1YBErFVQJVyFCFdOAqrtcASqHJjPCInCRkvBcG8D5XISCBqYlanjoIOWKx+iLr2Q3eSHzJw4LRs9y68BqmRdAaMYU0XmICjGyLXgjFuiBU2OEjguJEcQ5DRFAqCOEMsQEQ0UwQ+sgo+lFiMWg1nHjQOICTcHhIpK0mUKmKZUILkHPt2JLAznDlaXjiDeoCk3tvsxo2pWLOSK+agGd7mkXoxo2EUAKdUel6iO4qWn2DmdWOJz+UBF2uVw+Wk8/buu8FS7JZ2Aw0w96cdFYrL6mev3nRxYwhya1l/MRmoUIqwPUB+ZsF8LtMsHysEiwxdnYr9VfdhVoNUkRorLYSIe9t8MzWMBPrQ4LGkvzbxjcPhuc9i9GfRqXcpxff8etTqtDTZQSU64aU43K54brreeG3RW8ftgwDo8Uhwve4ZHiUKE+PFIcKHB4pDg8UhweKQ6PFF9f0jg8UhwY9Y09UpQVH4f3rp1JLopCWVn/9zWum6pUT+8GCVW/ujdsvZ5xi9dGbjbU/FeOhkpn04AtuBF8RgWcm+kmqOpEVBS7wxXrslN/5Tsa08QkLnNfctqpF1KZy2v0whAzt1e2WaAbXo7GLGCz8k0l1RHpGL6k9xa+ZF1WvM0UdY2i6k9taya5inMek6wfk0pbPCcPNOtid0VdrPxBqKoutWpYuF0w8zDok0A9qbBe+5rbZlPL+64PapSOraQpcNPNZvN/PSfj8Q==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},E=void 0,U={},I=[{value:"Events:",id:"events",level:3}];function v(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)(m.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,o.jsx)(d(),{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)(m.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)(u(),{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 A(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink