WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 01:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3ba6d9932bfbe4771c97d59fc130c043e12c7fd2
OpenSign/assets/js/70853c19.6bd16af0.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:()=>M,contentTitle:()=>N,default:()=>x,frontMatter:()=>u,metadata:()=>o,toc:()=>I});const o=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//GFnBnO5eOQnFkzx2PLujfsHc4Sre/YNGAR2tCIzAmtWJeNEwTLFwjaQJ5F3CGUtNAbDoBLqZcWVjoHpz0hh2VJcH11BstEhAkIC7nFiGicEXGMBnCBytnWRE3Uy5cvoV/87dLfV6+OW7AQuMSo++rVRB3BuwQVcLAiVmiKKQscIh3mKSoXgEuE9QJhKaSs1mhN1Pv37ydqPVEAE1YQTFgXJsxLn7DAz7hVhn7izeXp9Xn/Ynw7/mPYr+f17E8M3SDaoRm8qSnmQu5KuL46q6cVT3enL3rnDwso7cr5oURuEQySisBVVFjtLawMrtkaofLc9Yx3laXRGxoBWPuvbW1Gg7cX/aumLp4CUy7kFkn/vDc426LJEq22xQx/v7zoT5gn2dDXtFTH+/vX1QdFViS9MkDjwXl/NO6dD+v50CB3TxJM1KYMNGHndQtK0m3wVM4jLJYEnwGckvOAnOdCzt8J+74Yg0uMzuMEXIIQGT534DDNJCWy3nBwgMBXBoEGTW4aUgYXb71TPhMjlBp+avkjZE9m8PMwW9XHzWcgxAv55gFCgyUwPgaLj4PiI1lh01z5HzglTloQ6jSTuPecaKBByhIP9nNSRrXUN4+Jr+fcQOPEXIS8MvO0fzUe/DY47Y37W46qY/PloPq5BRGGUuzNMBXFF+aYSswBUc+FqMrje2+xFdGXgYkFTGdoODllELEuo4fVd/75Vb3UAmbwrxyt+1VHK9Zd77zbhkYvRISQG0mvLr8qPDCHWjlUjhh5lknaKEKr9p+WuNfMhgmmnH7RKsJgRK/EayPphUhQY90SUSxgmSFtnUBLDLmR9FUSWWeEilnA5tqk3DVH8J7T1mNdljiX2W67vdK5OSpfj0e5kb+UJK1Qp2yzCZgTrmAoaW5nZPtmQ1MGbaaV9Tq87nQeu2SUhyFaO88l1N79FE/sN9ugzaV7yvIHO6uXs49kBLbWSK5ebBkoFMHotjLq9nWnc/uv0tKTJ43TKbpEqBiWRRIxWsUBZH4nOrMCHnOhgO695sU/ZzUao81+oz9Ns31OOOl0bo9rJxw/dkLtXyOBS4M8WgHeC+vs85q8T4/9Bh7fLmsDTx4beG3RgNIO5jpX0fMatbv2fkNOajN+fmzGQC24FFFRQRrrO1TPa0lzeeeXJ1Xv0yJx0clSmFQQFfNsy9TmuDfSYpgb4Vase7Nm90c8E0d+vnsz3UwDRhtAUx7PtC005i5hXdZe1unYolmgsYWAIoHWOdFyFc30fUtnqOhElHxmKR+2eSbai2O2CXY5eJZ9AjXmR5/GYB2PhYr3c00fnDKiwPnYbLmmjhDPxL9xxYLK802qgAkCTII8QlNEifBw9XDy9auo7qq5/ywhuXNdKFHG9TJDNaJrCqFiccx2C6HvUIY6xaKEmSBU5P/7z38LjupeU4D2BVzmBjK9REOnDd2A5hLvxUziU1VT5KlEa+UKhHIYGzqpIxELx/2jg3JnyDM+E1IQzIlME7eBxk6xLbpuugQNTX1vqBIb4QIl7Q6QWt+RHKeB506nxRrVtXSpzd2cVAqAwyy3QqG1YBErFlQJVyFCFdOAysFcASqHJjPCInCREvFcG8D5XISCBNOeNjx0kHLFY/TVWtKbvJD5K4oFo2e5dWC1zAtDaMUU0XkTFWJkW/BGLNAbToMROi4kRhDnJCKAUEcIZYjJDBXBDK2DjJYXIRZCrePGgcQFmgLDRSTp9IVMU+4RXIKeb8WWBDnDlaX7i1eoCk3tvsxoOsaLNSK+agE9B+jYo6I3AUAKdUe17SO4qWH2DmdWOJz+UAF2uVw+2k8/bvO8FS7JZ2Aw0w98cTFY7L4me/3nRxYwhya1l/MRmoUIqxvXB9ZsF8TtMiPzsMjIxWXa79VfdhloN0kRorLYyJ+9t8MzWMBPrQ4LGlvzbyjcPhuc9i9GfZJLSdHvv+NWp9WhIcqhKVeNpUZlf+J6qz+xu4PXDyfMoatxeBEeuhqHkvahq3GAwKGrcehqHLoah67G15c0Dl2NA6K+sa5GWfFxeO/ameSiqKyVDQNfFLupavvUaEioXNa9Yev1jFu8NnKzoeG/cjRUa5sGbMGN4DMq4NxMN0FVJ6Iq2h2uWJed+iff0ZgWJnKZ+5LTToGRylyeoxeGmLm9tM2K3vByNGYBm5VNmFRHxGP4kho0fMm6rGjmFHWNok1AY2smuYpzHhOtl0mlLZ6TB5p1sbuiLlb+IKuqKbVqaLhdMPNm0CcZ9STDeu1rbptNTe+nPshROraipsBNN5vN/wFVYPUc","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 s=t(74848),i=t(28453),a=t(33617),r=t.n(a),d=t(17543),l=t.n(d),c=t(86013),h=t.n(c),p=t(63723),E=t.n(p),m=(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:"eJztWetu27gSfpUpC+ylUGynmwUO/Gu9qbdrnFyM2EGxiI2UlsYSNxSpJSk7huF/50nOo50nORhRUmQndbftIigK//GFnBnO5eOQnFkzx2PLujfsHc4Sre/YNGAR2tCIzAmtWJeNEwTLFwjaQJ5F3CGUtNAbDoBLqZcWVjoHpz0hh2VJcH11BstEhAkIC7nFiGicEXGMBnCBytnWRE3Uy5cvoV/87dLfV6+OW7AQuMSo++rVRB3BuwQVcLAiVmiKKQscIh3mKSoXgEuE9QJhKaSs1mhN1Pv37ydqPVEAE1YQTFgXJsxLn7DAz7hVhn7izeXp9Xn/Ynw7/mPYr+f17E8M3SDaoRm8qSnmQu5KuL46q6cVT3enL3rnDwso7cr5oURuEQySisBVVFjtLawMrtkaofLc9Yx3laXRGxoBWPuvbW1Gg7cX/aumLp4CUy7kFkn/vDc426LJEq22xQx/v7zoT5gn2dDXtFTH+/vX1QdFViS9MkDjwXl/NO6dD+v50CB3TxJM1KYMNGHndQtK0m3wVM4jLJYEnwGckvOAnOdCzt8J+74Yg0uMzuMEXIIQGT534DDNJCWy3nBwgMBXBoEGTW4aUgYXb71TPhMjlBp+avkjZE9m8PMwW9XHzWcgxAv55gFCgyUwPgaLj4PiI1lh01z5HzglTloQ6jSTuPecaKBByhIP9nNSRrXUN4+Jr+fcQOPEXIS8MvO0fzUe/DY47Y37W46qY/PloPq5BRGGUuzNMBXFF+aYSswBUc+FqMrje2+xFdGXgYkFTGdoODllELEuo4fVd/75Vb3UAmbwrxyt+1VHK9Zd77zbhkYvRISQG0mvLr8qPDCHWjlUjhh5lknaKEKr9p+WuNfMhgmmnH7RKsJgRK/EayPphUhQY90SUSxgmSFtnUBLDLmR9FUSWWeEilnA5tqk3DVH8J7T1mNdljiX2W67vdK5OSpfj0e5kb+UJK1Qp2yzCZgTrmAoaW5nZPtmQ1MGbaaV9Tq87nQeu2SUhyFaO88l1N79FE/sN9ugzaV7yvIHO6uXs49kBLbWSK5ebBkoFMHotjLq9nWnc/uv0tKTJ43TKbpEqBiWRRIxWsUBZH4nOrMCHnOhgO695sU/ZzUao81+oz9Ns31OOOl0bo9rJxw/dkLtXyOBS4M8WgHeC+vs85q8T4/9Bh7fLmsDTx4beG3RgNIO5jpX0fMatbv2fkNOajN+fmzGQC24FFFRQRrrO1TPa0lzeeeXJ1Xv0yJx0clSmFQQFfNsy9TmuDfSYpgb4Vase7Nm90c8E0d+vnsz3UwDRhtAUx7PtC005i5hXdZe1unYolmgsYWAIoHWOdFyFc30fUtnqOhElHxmKR+2eSbai2O2CXY5eJZ9AjXmR5/GYB2PhYr3c00fnDKiwPnYbLmmjhDPxL9xxYLK802qgAkCTII8QlNEifBw9XDy9auo7qq5/ywhuXNdKFHG9TJDNaJrCqFiccx2C6HvUIY6xaKEmSBU5P/7z38LjupeU4D2BVzmBjK9REOnDd2A5hLvxUziU1VT5KlEa+UKhHIYGzqpIxELx/2jg3JnyDM+E1IQzIlME7eBxk6xLbpuugQNTX1vqBIb4QIl7Q6QWt+RHKeB506nxRrVtXSpzd2cVAqAwyy3QqG1YBErFlQJVyFCFdOAysFcASqHJjPCInCREvFcG8D5XISCBNOeNjx0kHLFY/TVWtKbvJD5K4oFo2e5dWC1zAtDaMUU0XkTFWJkW/BGLNAbToMROi4kRhDnJCKAUEcIZYjJDBXBDK2DjJYXIRZCrePGgcQFmgLDRSTp9IVMU+4RXIKeb8WWBDnDlaX7i1eoCk3tvsxoOsaLNSK+agE9B+jYo6I3AUAKdUe17SO4qWH2DmdWOJz+UAF2uVw+2k8/bvO8FS7JZ2Aw0w98cTFY7L4me/3nRxYwhya1l/MRmoUIqxvXB9ZsF8TtMiPzsMjIxWXa79VfdhloN0kRorLYyJ+9t8MzWMBPrQ4LGlvzbyjcPhuc9i9GfZJLSdHvv+NWp9WhIcqhKVeNpUZlf+J6qz+xu4PXDyfMoatxeBEeuhqHkvahq3GAwKGrcehqHLoah67G15c0Dl2NA6K+sa5GWfFxeO/ameSiqKyVDQNfFLupavvUaEioXNa9Yev1jFu8NnKzoeG/cjRUa5sGbMGN4DMq4NxMN0FVJ6Iq2h2uWJed+iff0ZgWJnKZ+5LTToGRylyeoxeGmLm9tM2K3vByNGYBm5VNmFRHxGP4kho0fMm6rGjmFHWNok1AY2smuYpzHhOtl0mlLZ6TB5p1sbuiLlb+IKuqKbVqaLhdMPNm0CcZ9STDeu1rbptNTe+nPshROraipsBNN5vN/wFVYPUc",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},N=void 0,M={},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,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,s.jsx)(r(),{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)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(l(),{parameters:void 0}),"\n",(0,s.jsx)(h(),{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,s.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 x(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink