mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-27 12:04:52 +02:00
1 line
13 KiB
JavaScript
1 line
13 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6235],{74402:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>T,frontMatter:()=>I,metadata:()=>s,toc:()=>N});const s=JSON.parse('{"id":"API-docs/v1.1/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.1/save-update-webhook.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/save-update-webhook","permalink":"/docs/API-docs/v1.1/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":"eJztWdtuIzcS/ZUKB9jdCG3JnjjAQk9RHO1EWF8ES4axsAwP1V1SM6LIDsmWLAgC8rB/sE/7mk+bLwmK7G5d7NFkZgJjMNCLLmRVsS6HRbJqyRwfW9a8Y7c4TLWesPuIJWhjIzIntGJN1k8RLJ8haAN5lnCHUNBCq9sBLqWeW1joHJwOhBzmBcHN9TnMUxGnICzkFhOicUaMx2gAZ6icrQ/UQL169Qra/m+T/tZqJ3WYCZxj0qzVBuoIblNUwMGKsULjpyxwSHScT1G5CFwqbBAIcyFluUZ9oN6+fTtQy4ECGDBPMGBNGLAgfcCiMOMWGYaJn67Obi7al/2H/n+67WpeD3/B2HWSHZrOTxXFSMhdCTfX59W04tPd6cvWxXoBpV0x35XILYJBUhG4SrzVwcLS4IptI1SBu5oJrrI0ekcjAMvwta1Nr/Pmsn29qUugwCkXcoukfdHqnG/RZKlW22K6P19dtgcskKzo675QJ/j7x8V7RZYkrSJA/c5Fu9dvXXSr+dggd88SDNSqCDRh53UdCtJt8JTOIywWBJ8AnILzgJyXQs6fCfu+GINLjc7HKbgUITF85MDhNJOUyFrdzgECXxgENmhysyGlc/kmOOUTMUKp4bt6OEL2ZIYwD8NFddx8AkKCkK8eIDRYAONDsPgwKD6QFVabK/8Fp8RpHWI9zSTuPSc20CBlgQf7KSmjXOqrx8SXc26gcWIkYl6aeda+7nf+1Tlr9dtbjqpi8/mg+r4OCcZS7M0wJcVn5phSzAFRL4Wo0uN7b7El0eeBiUVMZ2g4OaWTsCajh9XfwvOrfKlFzOCvOVr3o04WrLncebd1jZ6JBCE3kl5dYVVYM8daOVSOGHmWSdooQqvGL5a4l8zGKU45/aJVhMGEXok3RtILkaDGmgWiWMQyQ9o6gZYYciPpqyCyzgg1ZhEbaTPlbnMEHzltPdZkqXOZbTYaC52bo+L1eJQb+UNBUo/1lK1WEXPCeYaC5mFItq9WNGXQZlrZoMPr4+OnLunlcYzWjnIJlXc/xhP7zTZoc+mes3xtZ/lyDpFMwFYaycU3WwYKRTB6KI16eH18/PDPwtLTZ43TU3SpUGOY+yRitBpHkIWd6MwC+JgLBXTvNd/8dVajMdrsN/rjNNvnhNPj44eTygknT51Q+ddI4NIgTxaAj8I6+7Im79Njv4EnD/PKwNOnBt5YNKC0g5HOVfKyRu2uvd+Q08qM75+a0VEzLkXiK0h9PUH1spZsLu/C8qTq49QnLjpZvEmeyM+zLVM3x4ORFuPcCLdgzbslezzimTgK8827+9V9xGgDaMrjmbZeY+5S1mSNeZWOLZoZGusF7GzsOaebwM/50Ovbyp2GCx1PglE+2Vb5cyaMC5LqNrCl+ZCSZ6NrOGWZSz6bcNPQGarGSf24fsxW0XJHiOUqGerHOhHRESz50HoZPBON2Un95BkenmUfRY/50ceyWMfHQo0/xHe/jkaPEBNAsRWTCho8E//GBYvKkG9SRUyQ91PkCRoPDwLi9frIbZdw2lV0/yFGckfaK1EA6ipD1aP7EYXXG7Fbg71FGesp+uppilCrlSzv/vt7xVWrVXcrv3F8ZfUqN5DpORo69OgiNpL4KIbS1z4Ap35uXb5FPpVorVyAUA7Hhq4MiRgLx8Prh5J4zDM+FFLQfiMyTdwGNrasrdO916VoaOrvhkrCCc5Q0jYFnjs95Y5EVdfiuTaTERWSI+AwzK1QaC2gSrmKibCMaERVaK4AlUOTGWERrDOktQi6aeUMjx1MueJjDMXhTWclKAXtMzB6mFsHVsvcqwyOC6lNKFF7gxRiEsrT7ceMpoBG6bVgMCX4zRDGuUjQRhDrhKrkFGUyQSUwROsgI11EjJaE5krqeOIDSDsRMk3ZTnAJerSlI7E7w5WlG1PQpYxB5bDMaLo4YFCwVruxSBE+F2pii6fHXYWrWxxa4fD+HyVC5/P5ky307TbPG+Eo41xjpq1w2izW3GPhyqyyKaT6EyS9QYUePxubai0j0bF9uotptJGizBo9dIQQ22h1O/6A+Bbe/fY/OEduFKR6HtAa5wblAsblUuS5EPngtiq/w0h74KXk8TiAr7g9lx68Tbl799v/LVziHIQqthSZUqt186EUMfSLuqGt1ZpwFi7UZS3Rgku5g5grGCLYlBOUZoIDhyxwS6EmdWipBXVCDMyFCzVJGvd8W2b4B1MZbgtDTt0TrTxHuWZ9rRGNTy3KGVqSRaf0EAETsVsB3VSmMM7giF6ctyIZo/O2tZIEsmJ4HobJ4Rvq4Ig2hEtxAdwgWFSuDt0dFj+TZ5k2pIUIyo80dYwoAKiSTAtq+hR12Up+tAa6f7cIrZ4ZCi7klTuinfJusRMLi6vRun9e7RwI2/nW4AgNLejNXsclEwWc7kpYAqH1c2BNBwJlLR77i49/s4aT6YddOf4SgmZqr0Y9NDMRly+n9+zohidusIhJEaOyuHG5ab3pnsPsu/rx1hXiT2zuxnnnrH3Za5MylEiDw8qrhL/fTLnaWKlX9A5vtnqHu0fccn37O3QcD9WaQ8fx0G46dBwPEDh0HA8dx0PH8dBx/PKSxqHjeEDUV9ZxLIqiDh9dI5Nc+Kp30cwLBeu7su9GTcCUStnNO7ZcUnHixsjVioZ/zdFQHfw+YjNuBB9SjfPufhWVpVSqcE9wwZrsLDz5jvq0MJHLPFRld4r/VAsOHK04xsztpd2stneven0WsWHRIJ3qhHgMn1PzlM9Zk/lGqy8A+hYejS2Z5Gqc8zHRBplU/aXq0XbpeOJLx8UPsqqcUosNDbdrysEM+iSjnmVYLkNZerWq6MPUezkKx5bUFLj71Wr1B2V0QsI=","sidebar_class_name":"post api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Webhook","permalink":"/docs/API-docs/v1.1/get-webhook"},"next":{"title":"Delete Webhook","permalink":"/docs/API-docs/v1.1/delete-webhook"}}');var i=t(74848),r=t(28453),o=t(33617),a=t.n(o),d=t(17543),l=t.n(d),c=t(86013),p=t.n(c),h=t(63723),E=t.n(h),M=(t(18766),t(79329),t(9303));const I={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:"eJztWdtuIzcS/ZUKB9jdCG3JnjjAQk9RHO1EWF8ES4axsAwP1V1SM6LIDsmWLAgC8rB/sE/7mk+bLwmK7G5d7NFkZgJjMNCLLmRVsS6HRbJqyRwfW9a8Y7c4TLWesPuIJWhjIzIntGJN1k8RLJ8haAN5lnCHUNBCq9sBLqWeW1joHJwOhBzmBcHN9TnMUxGnICzkFhOicUaMx2gAZ6icrQ/UQL169Qra/m+T/tZqJ3WYCZxj0qzVBuoIblNUwMGKsULjpyxwSHScT1G5CFwqbBAIcyFluUZ9oN6+fTtQy4ECGDBPMGBNGLAgfcCiMOMWGYaJn67Obi7al/2H/n+67WpeD3/B2HWSHZrOTxXFSMhdCTfX59W04tPd6cvWxXoBpV0x35XILYJBUhG4SrzVwcLS4IptI1SBu5oJrrI0ekcjAMvwta1Nr/Pmsn29qUugwCkXcoukfdHqnG/RZKlW22K6P19dtgcskKzo675QJ/j7x8V7RZYkrSJA/c5Fu9dvXXSr+dggd88SDNSqCDRh53UdCtJt8JTOIywWBJ8AnILzgJyXQs6fCfu+GINLjc7HKbgUITF85MDhNJOUyFrdzgECXxgENmhysyGlc/kmOOUTMUKp4bt6OEL2ZIYwD8NFddx8AkKCkK8eIDRYAONDsPgwKD6QFVabK/8Fp8RpHWI9zSTuPSc20CBlgQf7KSmjXOqrx8SXc26gcWIkYl6aeda+7nf+1Tlr9dtbjqpi8/mg+r4OCcZS7M0wJcVn5phSzAFRL4Wo0uN7b7El0eeBiUVMZ2g4OaWTsCajh9XfwvOrfKlFzOCvOVr3o04WrLncebd1jZ6JBCE3kl5dYVVYM8daOVSOGHmWSdooQqvGL5a4l8zGKU45/aJVhMGEXok3RtILkaDGmgWiWMQyQ9o6gZYYciPpqyCyzgg1ZhEbaTPlbnMEHzltPdZkqXOZbTYaC52bo+L1eJQb+UNBUo/1lK1WEXPCeYaC5mFItq9WNGXQZlrZoMPr4+OnLunlcYzWjnIJlXc/xhP7zTZoc+mes3xtZ/lyDpFMwFYaycU3WwYKRTB6KI16eH18/PDPwtLTZ43TU3SpUGOY+yRitBpHkIWd6MwC+JgLBXTvNd/8dVajMdrsN/rjNNvnhNPj44eTygknT51Q+ddI4NIgTxaAj8I6+7Im79Njv4EnD/PKwNOnBt5YNKC0g5HOVfKyRu2uvd+Q08qM75+a0VEzLkXiK0h9PUH1spZsLu/C8qTq49QnLjpZvEmeyM+zLVM3x4ORFuPcCLdgzbslezzimTgK8827+9V9xGgDaMrjmbZeY+5S1mSNeZWOLZoZGusF7GzsOaebwM/50Ovbyp2GCx1PglE+2Vb5cyaMC5LqNrCl+ZCSZ6NrOGWZSz6bcNPQGarGSf24fsxW0XJHiOUqGerHOhHRESz50HoZPBON2Un95BkenmUfRY/50ceyWMfHQo0/xHe/jkaPEBNAsRWTCho8E//GBYvKkG9SRUyQ91PkCRoPDwLi9frIbZdw2lV0/yFGckfaK1EA6ipD1aP7EYXXG7Fbg71FGesp+uppilCrlSzv/vt7xVWrVXcrv3F8ZfUqN5DpORo69OgiNpL4KIbS1z4Ap35uXb5FPpVorVyAUA7Hhq4MiRgLx8Prh5J4zDM+FFLQfiMyTdwGNrasrdO916VoaOrvhkrCCc5Q0jYFnjs95Y5EVdfiuTaTERWSI+AwzK1QaC2gSrmKibCMaERVaK4AlUOTGWERrDOktQi6aeUMjx1MueJjDMXhTWclKAXtMzB6mFsHVsvcqwyOC6lNKFF7gxRiEsrT7ceMpoBG6bVgMCX4zRDGuUjQRhDrhKrkFGUyQSUwROsgI11EjJaE5krqeOIDSDsRMk3ZTnAJerSlI7E7w5WlG1PQpYxB5bDMaLo4YFCwVruxSBE+F2pii6fHXYWrWxxa4fD+HyVC5/P5ky307TbPG+Eo41xjpq1w2izW3GPhyqyyKaT6EyS9QYUePxubai0j0bF9uotptJGizBo9dIQQ22h1O/6A+Bbe/fY/OEduFKR6HtAa5wblAsblUuS5EPngtiq/w0h74KXk8TiAr7g9lx68Tbl799v/LVziHIQqthSZUqt186EUMfSLuqGt1ZpwFi7UZS3Rgku5g5grGCLYlBOUZoIDhyxwS6EmdWipBXVCDMyFCzVJGvd8W2b4B1MZbgtDTt0TrTxHuWZ9rRGNTy3KGVqSRaf0EAETsVsB3VSmMM7giF6ctyIZo/O2tZIEsmJ4HobJ4Rvq4Ig2hEtxAdwgWFSuDt0dFj+TZ5k2pIUIyo80dYwoAKiSTAtq+hR12Up+tAa6f7cIrZ4ZCi7klTuinfJusRMLi6vRun9e7RwI2/nW4AgNLejNXsclEwWc7kpYAqH1c2BNBwJlLR77i49/s4aT6YddOf4SgmZqr0Y9NDMRly+n9+zohidusIhJEaOyuHG5ab3pnsPsu/rx1hXiT2zuxnnnrH3Za5MylEiDw8qrhL/fTLnaWKlX9A5vtnqHu0fccn37O3QcD9WaQ8fx0G46dBwPEDh0HA8dx0PH8dBx/PKSxqHjeEDUV9ZxLIqiDh9dI5Nc+Kp30cwLBeu7su9GTcCUStnNO7ZcUnHixsjVioZ/zdFQHfw+YjNuBB9SjfPufhWVpVSqcE9wwZrsLDz5jvq0MJHLPFRld4r/VAsOHK04xsztpd2stneven0WsWHRIJ3qhHgMn1PzlM9Zk/lGqy8A+hYejS2Z5Gqc8zHRBplU/aXq0XbpeOJLx8UPsqqcUosNDbdrysEM+iSjnmVYLkNZerWq6MPUezkKx5bUFLj71Wr1B2V0QsI=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},u=void 0,g={},N=[{value:"Events:",id:"events",level:3}];function S(e){const n={code:"code",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(M.default,{as:"h1",className:"openapi__heading",children:"Save or Update Webhook"}),"\n",(0,i.jsx)(a(),{method:"post",path:"/webhook",context:"endpoint"}),"\n",(0,i.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,i.jsx)(n.h3,{id:"events",children:"Events:"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"1. viewed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a signer views a document, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"2. created:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is created through the draft template API, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"3. signed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"4. completed:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is signed by all signers, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"5. declined:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When a document is declined by a signer, this event will trigger."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(M.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{parameters:void 0}),"\n",(0,i.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,i.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,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(S,{...e})}):S(e)}}}]); |