diff --git a/404.html b/404.html index fd88e754e..0659d91d3 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/0028a090.db26237b.js b/assets/js/0028a090.db26237b.js new file mode 100644 index 000000000..77983c4c7 --- /dev/null +++ b/assets/js/0028a090.db26237b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var i=s(85893),a=s(11151),t=s(58219),l=(s(62316),s(51039)),r=s.n(l),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9ty2ziyv4LlS2ZUlGwpjifj2to6nsSTUSa+nNiZXGxXApEtCTEJMABoWUnpbb9kP22/5FQ3AJKSJdtJpma9dfSSWESj0Wj0DY3uL5HlIxPtnEYnkBcZt2Ci8zhKwSRaFFYoGe1EJ2NgYZg91XxohRyx3aM+A8kHGRhWGtCGWcUSDQiUlMaqXHzGUWYD5pgZ0Jc4lxs2yEootJDWsKHSbAQSNCfEqUrKHHBgIuyYFRpSGAoJKTNWl4ktNZgOe1UoyUyZJGDMsMzcykJJpoaMV2vGzI6BSNVgSy0N46yU4lMJrNVSg4+Q2H7aarEfUjBiJLmFFIkL09+L9MeYTcYiGbOESzYA3GqKO/UEQ4PcAccxJWlNU0AihgKBPbIO201TgTTyLJvGjLNWq9RZq8WEYYVWlyKFNKymhkNkKSfWMiEt6CFPgHgFiEWOaJmAnHGZsiFPRCbsPBtZKozVYlDiyp0zeSZPRLHDXhWZ4imbqlKzo6e/1uBWMfx22mo9hUE5Yq/6rdb5D2NrC7OzscGLoqMKkMitjA9MJ1H5RoqARTokXoEGxEr8Am5ENmU8TdlEpCOwhg5EskQVU5YopVMhnWgUfARMlvkAtIlpN7nSwIRknGng6bRtVbs0wJ4fHx4gG3JuO+woK01cLZcKDYnNpg49sifs6oE7ne0tlCEhRzHL+QVySVj2qRTJBW7bgKSj9SLTOZOMMXYmW63XSHPFIWG8nKeM2bEwbAKDsVIXDC5xeCKyjFktRiPQrRYh+fDhg0P2xf1HeCMCP4t22Fnk8Z1FcRPATgtw408Pn7za3zs4eX/y9mhvASqI8QJk/+lZ1AQbimwR2auXLxZwSZ4vAh3s7i+uKJX1UEcZcANMw6WACZ0aCobjSuDXwmQEAG1w/mn9fY41i7Qc958d7L28TolnY85FNge4t7/bf7EEshgrOY/y6LfDg2U4S93A2D945ljVhJrVP87n9uePctef7El/f+/4ZHf/KEyfnckPHz6QWB2XRaE0ytFrpx07KC9n8hfI1IRxDSSKicpzJVnBNc/BkqEdc0vDGj6VQkPqLCXPsqBmO4imzVotFKGdVov1ZSoS1DRnNaYFoKF00B0HihqIoMfecjnQhl6iaXPWCRVuwp2xKDK0SwiqAY2eFZcwj/gqZlNE/BRQcBzasdLis5KWZyQ1l6CtSHjWtAlIIFlSyzVZtEIJacNXvwJ763UfTQNpvDdaSFqK7MqFpBED7JJnJRhP1SRmY6TqJRQaDBlwjxdZKVM2BjEar1yPpx9LY+cQs9IEsxyo8GuFcyL2ArFtyDMDTAzneJnzC2isxlTh3EWH/TJlKQx5mdmYCTRnVpfQYQfKMl4UmUjI1aJ3cH6s1NCmU/YC4QlBnUIijpy7QQeTCnQ1aLhwkFD4OYE6lDTnn3B7ZJbtmEum5MJBJypTGtEvyBB9n2ckS5S0IG2H7V5ykRH1breGCZlkZQpskPHkIqZIIWYafSMeyxSyTE1iJ/IEQh6bmE4MYgYyFEMlcQNS+eWFqX1y5wQNVKVROBZYTWsI0+SqdwlDhQsjC4KSMTI9MTEuZh/VgFlhM4hRZQsupzFLXQwCV3agrmKWjCG5oL80T4Vig9JaJd2+Uq2KVE2k5+VQSWvE5yUaGUa+nqG9mG3FbDtmj2PW3YxZtxez7lbMutsx6z6OWW8zZr1ezHpbMettO7J6jz2recXfJgHdnmOybTCX3W/uouV9IQxpNppMU1nhyZwVPpPdDmu1Kn2iz+TJyVVV7tm5NAI5i2LmxtBsnkU73Zj5D1foDh72fgoAU/y9jdx1vyf4u4un4X6P8XeveyZnftEeEWN5XtxACA7/+USEn16e8KP31mdRMG34EW2Sg533354sHJjVG3qIGxJSWMEzs3pPAeL+baumbGFnW7gzkt7V2/JRy33bUyArjJDtdENkaxtDwQwQIb0FFjzq1N5mBQfcoveNAZ6q793/Nu6/slmrmVCB3D9ONEn7Xnb81KHwgOz2amZ4gPvHipqw72XEY2QE+q3VXMDR+8cCT1UY8LGAG9vcancftXubva05NuAV3QHkeTtN29Pp9DtZ6C7SGB759SnY9MGsiwExFzLUKl9yU6GLRA3lwyf6O0T3+xjTD6BKx2D+YT6bEzIPzYDcqpRPHxiHKkyt4jiEr6O4aYNMGkI6KAuTjJVIPPEIE6K3Ad4GKRnRRsanG/v7Gw1Wuo/tPA/8ZeEr/m4T65tf87yTpp1F2LkTanzNWZrGbMn35QNpyvI8X/XdDaC7PJM/oyL40G21LniAv0Ydlkh9vf5KXakHeKpkRuvT5W65riz4l7EIKSAvN2wBQMOozLiGK7ylGqEk8eVPsEQLWhSUqA7z6VJL90GXaCROsB8OfSj/oxdw3ME8Avxy+7xrG2si0TCCK8LhUslIjEgpwRtj1neMdz4ebgzI9jp3SL8SXghMLmRgLX0Fm3SWEeEOrXExx0NdvJcbsHOb4YaFmUuu5nT6dNHobpLf8/eSGxyfh7h/Zr9BWRh0yQ6Xv4ty7kOXaAj138qOQZ9F59UcdyWHtDGXLZvMzm/QJ1YrTQoZH0B2XdfurA3N7XjJajAHB3Ihq0wCkbwZKKBRfrUw6gdnS/TMbbsp4MG4BzUJfGaZMCGdMs+05myfb6I8oAT3IDEAFiawQSWS3y3yFWF3k3lnEfzx3LIEwjECrHJ9YbVbVpg7miZjEEcupMjLvEpaDiusgWW59/JNfuFMfGsJKzSP99oK/OqWFfxj0YoFzmSXUgshKUGGgS0PBj3I/bMMDcpud4HfYjPm3Oa3Oryv18Swr6YmLvGTCOo8ZKWFZrUadtgheiXMmLpJmANLEigs5su+V0crku+mo11KJTVzZKs9UxPqr5bBVcJ0F+lcoPtPk0MP933BF3LtbsLY3MZ/kUDOkX3nYMklBHP3DLUqG5iT6N03Y+jJWnD9URypgsoalOyn0U6UYvFEeLKPYkINxv6i0mm08yXyKXz80yfIcebGR4NlGF8ik4wh5/hXIAkLN/BdN4rDs2oUR5SzwSoOZFq049+HoxhvGAW+s4FBHDRv50uAcu/iUezv7dFO5B7MoziCK54XCOw/MZCJwssxoZiFFW/CVX2pcRn6oypgQDz4PPiNaGjqbKFy5ZswNTHMar7WyLjWfBotFsmEd8FwjXPzqoePbBp0RVjUiOqtisCiOBIW8uYqK05Nq6/ndAIKd0Kp3a+dS8fC869eE+fRc/u3TPTvMEt4fkcuudHrC88f2S7eHyEN0XS7fjqNGT1ZdG6TmABPu+Wj5pouNry25smqJ/XGS54ZqzJL8Y0MuO7Qy/Y3V+RQURbPkpKKhCofMbezitRqZ91ZHF3dvpkrlqh2eK9nP2QwtKwsCtAsUVqC/rGZibs3m+ttbc3iaHr79qb/ldv7CQ9vcvvuXlOhQ10E8p+g9eHjWRyNb6f1t6oU4z9I7Nb2rPZ1vsynKhQcqHT6Ptit2W2AwakgHFad9eWhTkE3GDFQKgMur3GiP3RBlmIPMBZ54NNd9IIutAkOxRWhaUgAq3Eogx1sFfNBh3teZ/4RE2OzPfxAMaMpBwahZMBnHMIBhMI2rMZ0EMJVM1KNAPBkjGV01lHFh/j8T1VEWCGmShPIG3NDz/gZYFhqxyBc4YqQo/kYscEdquBo7r3TPB38gk6OKlIPT47uwEuKYNuuWM35abdLh4MdnhxhXZIY+jisw16ZihOBtXwOhGFcxC4FD7ULlW2fuqQDSOKICmVydYVix1cEtdl1glJhllIU1ynQqgL3GuK6KhKPSJUWyzF9GSozFgozx0eiomLkiSrvIpW3cJKzUUmvKRZVNhQpUVq2risS0pX30v0nLXUopfJigZBY61vzKXAFgRr4YwbSuOmcDbmxoGOs+UXO6xLvNxVKuCpAC5AJLGWBBse696VeGjfN82C+SOfVyxe+FjbsISjlADXQIYaUlQVJDWlCVTwWTm5x69cCJdQO0O9XBWjXQw8q8fK5tgK0wXppzZQecSk++/ppjEiUATaAMc8cqDcV+BaF9KCGzxMTbO2///mvBl0rI87rhLkVeJriY8AtFNL91gk8RtwaCrSAap4ixAf6fxadAFJHSvM+V2mlSObuMn6EFYXWVHbRKipvhgxcEXh4nKjsrYmDjTU+rMQ3Ck1vCVQsrgrcL1wJYxvlT+Hl8bp9eAnIx6RBA4UhqNUo83LaVPCKLl9mVaOjIi0xXzlXucEFXbjZnTl/V99JvSnGclAljYvIe5ub+N/CwYfi9VBOXdfzZ9O/RfHdL8Q3XwdChfQyUawl5pdx7zdTyDwZo5Cs0Pka/OZQo3nR34Dp8/HgWSIOxfP+q8/97oHom758+Sh50t/uXxRv/njy/OcOTJ93k94f0ze9P+zb15npf1Qi+e35+J38wwyePCrfvnmn377p67evX1r++tHuQI7l4NmvIpk++jjobYoXT55vvnvdnQye/br57o+fi3eE/NfNdxcXm0l+8GQgdxGmePvmf8Xhx72H+5/3Pu+f7F3tf85+7vCDTx+fXCU/71/sbbff9XV7/3Dw+8dPtnj5KH148EZsP4Z9eC1PNl8kUVMahMyEhPfhqN/Tvt/jYc9IKLaWHfuxysGOSdapXl4rLMgvXCm51VPGR1xIhqzTf6IUgNZK33ymX0fZTYzY2tx8362Y8Og6E/qSHp6oN+VEXYD8a3faXN665ZHUq5yk3jmUSDggGo/mNtv87jZpICm1sNNo5/RLdNXmhWi78Z3T89l5HCFjFebACmWIYm7H0U60sZgSwxYhyrecfnE6WCma4TLFp6FrysYLsXHZjWbx4oylqrkS2lg+EnLUvnHWeb3TYzwNx/C5/dZJi0L8Dpi18OxsQsWRQCkYA8e4HxmIh/yyzgfuhaMKmbqlybf6TBbTaSGbNpcgW/RpS1JejYzXaUg3UQapSiBF9Y6iKsmDf1Zpm9Na8qoMSUiQdCmz0Nvaoiv4T126qz58TNfAre3ZueNw40pEKddmXO8eA+YCVP9pPmCLooUAaS5KWQxSVgYMK+KFECQKOVR05v4cDguQxxiDo2Zddq9fuyFLVF6VPQfwf//zXzQj+Gda5m/ssNSsUBPQ2OJGLV4ZXAmMehGYCDOUVaTkO88zMAZTjdLCyHWniRHVQYRQMuEFH2CTGAaqQlrlao8a1sZ02Osx4CMIDj3QriTkEjK0MCxTivqmMOwprcqbHXBsovTFEEnC5rYBdkNgMGcAwhSQYy4TfJBwKkSBEPaJYXBeaGGAcZEjMPW5DYciEYgY7aLmiWU5l3xEEU1M13/kQhF6GbQa4B3LqKx0twjsqACwbov0INJhT/HWRhvHjylYPPbUXSBM7C5w3kz6PrQBXpYLXF4kYOpCsgwuQZPJcNfvMstYoay7EmNI1zxbRGQ1lwYTDI6gcDQV+3yYT2ukfNph+CqCLgmDXRSATMgLbO1ps9NKzF7DwAgLdepjMplcM18/zs95Juy4HGDgrOp5I/pIxq45vfrxIxob0Lk5HB5jG2cSgqAVa24Q8Ib3ajwhrxaUjRdiaWieiQSkgYYP2n129IJdsoedzShuGOw7ELzxov9k7+B4D/GiS3H61+1sdjYpX6uMzblsLEWtrVWn66LmNp5n1h2x647YdUfsuiO2AbXuiF13xK47YtcdseuO2HVH7Lojdt0Ru+6IXXfErjti1x2x647YdUdszYZ1R+y6I3bdEbvuiF13xK47YtcdseuO2HVH7Lojdt0Ru+6IXXfErjti/790xPrKMAwcN4qMC9motnVFgacLfbLncTTGosGd0+jLF3y0fqWz2Qw/fypBY8XheRxdci0we071hnEorMNStAuYRjvRE/cY0D7B5WMn9lSIslBmiXWBbsYuHf6NsM26xqPD45Mojga+lzdXKc7RfIJ9vnwS7URos6kluCo5p+9foozLUUnVcZHDi/WAvLTj+WLCCyom9H80iuy4nDaonK8ydFvBf3FjSyf8HYtBfofpPypwN7JygudtgMYTPJ/NZv8HXmbasQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9ty2ziyv4LlS2ZUlGwpjifj2to6nsSTUSa+nNiZXGxXApEtCTEJMABoWUnpbb9kP22/5FQ3AJKSJdtJpma9dfSSWESj0Wj0DY3uL5HlIxPtnEYnkBcZt2Ci8zhKwSRaFFYoGe1EJ2NgYZg91XxohRyx3aM+A8kHGRhWGtCGWcUSDQiUlMaqXHzGUWYD5pgZ0Jc4lxs2yEootJDWsKHSbAQSNCfEqUrKHHBgIuyYFRpSGAoJKTNWl4ktNZgOe1UoyUyZJGDMsMzcykJJpoaMV2vGzI6BSNVgSy0N46yU4lMJrNVSg4+Q2H7aarEfUjBiJLmFFIkL09+L9MeYTcYiGbOESzYA3GqKO/UEQ4PcAccxJWlNU0AihgKBPbIO201TgTTyLJvGjLNWq9RZq8WEYYVWlyKFNKymhkNkKSfWMiEt6CFPgHgFiEWOaJmAnHGZsiFPRCbsPBtZKozVYlDiyp0zeSZPRLHDXhWZ4imbqlKzo6e/1uBWMfx22mo9hUE5Yq/6rdb5D2NrC7OzscGLoqMKkMitjA9MJ1H5RoqARTokXoEGxEr8Am5ENmU8TdlEpCOwhg5EskQVU5YopVMhnWgUfARMlvkAtIlpN7nSwIRknGng6bRtVbs0wJ4fHx4gG3JuO+woK01cLZcKDYnNpg49sifs6oE7ne0tlCEhRzHL+QVySVj2qRTJBW7bgKSj9SLTOZOMMXYmW63XSHPFIWG8nKeM2bEwbAKDsVIXDC5xeCKyjFktRiPQrRYh+fDhg0P2xf1HeCMCP4t22Fnk8Z1FcRPATgtw408Pn7za3zs4eX/y9mhvASqI8QJk/+lZ1AQbimwR2auXLxZwSZ4vAh3s7i+uKJX1UEcZcANMw6WACZ0aCobjSuDXwmQEAG1w/mn9fY41i7Qc958d7L28TolnY85FNge4t7/bf7EEshgrOY/y6LfDg2U4S93A2D945ljVhJrVP87n9uePctef7El/f+/4ZHf/KEyfnckPHz6QWB2XRaE0ytFrpx07KC9n8hfI1IRxDSSKicpzJVnBNc/BkqEdc0vDGj6VQkPqLCXPsqBmO4imzVotFKGdVov1ZSoS1DRnNaYFoKF00B0HihqIoMfecjnQhl6iaXPWCRVuwp2xKDK0SwiqAY2eFZcwj/gqZlNE/BRQcBzasdLis5KWZyQ1l6CtSHjWtAlIIFlSyzVZtEIJacNXvwJ763UfTQNpvDdaSFqK7MqFpBED7JJnJRhP1SRmY6TqJRQaDBlwjxdZKVM2BjEar1yPpx9LY+cQs9IEsxyo8GuFcyL2ArFtyDMDTAzneJnzC2isxlTh3EWH/TJlKQx5mdmYCTRnVpfQYQfKMl4UmUjI1aJ3cH6s1NCmU/YC4QlBnUIijpy7QQeTCnQ1aLhwkFD4OYE6lDTnn3B7ZJbtmEum5MJBJypTGtEvyBB9n2ckS5S0IG2H7V5ykRH1breGCZlkZQpskPHkIqZIIWYafSMeyxSyTE1iJ/IEQh6bmE4MYgYyFEMlcQNS+eWFqX1y5wQNVKVROBZYTWsI0+SqdwlDhQsjC4KSMTI9MTEuZh/VgFlhM4hRZQsupzFLXQwCV3agrmKWjCG5oL80T4Vig9JaJd2+Uq2KVE2k5+VQSWvE5yUaGUa+nqG9mG3FbDtmj2PW3YxZtxez7lbMutsx6z6OWW8zZr1ezHpbMettO7J6jz2recXfJgHdnmOybTCX3W/uouV9IQxpNppMU1nhyZwVPpPdDmu1Kn2iz+TJyVVV7tm5NAI5i2LmxtBsnkU73Zj5D1foDh72fgoAU/y9jdx1vyf4u4un4X6P8XeveyZnftEeEWN5XtxACA7/+USEn16e8KP31mdRMG34EW2Sg533354sHJjVG3qIGxJSWMEzs3pPAeL+baumbGFnW7gzkt7V2/JRy33bUyArjJDtdENkaxtDwQwQIb0FFjzq1N5mBQfcoveNAZ6q793/Nu6/slmrmVCB3D9ONEn7Xnb81KHwgOz2amZ4gPvHipqw72XEY2QE+q3VXMDR+8cCT1UY8LGAG9vcancftXubva05NuAV3QHkeTtN29Pp9DtZ6C7SGB759SnY9MGsiwExFzLUKl9yU6GLRA3lwyf6O0T3+xjTD6BKx2D+YT6bEzIPzYDcqpRPHxiHKkyt4jiEr6O4aYNMGkI6KAuTjJVIPPEIE6K3Ad4GKRnRRsanG/v7Gw1Wuo/tPA/8ZeEr/m4T65tf87yTpp1F2LkTanzNWZrGbMn35QNpyvI8X/XdDaC7PJM/oyL40G21LniAv0Ydlkh9vf5KXakHeKpkRuvT5W65riz4l7EIKSAvN2wBQMOozLiGK7ylGqEk8eVPsEQLWhSUqA7z6VJL90GXaCROsB8OfSj/oxdw3ME8Avxy+7xrG2si0TCCK8LhUslIjEgpwRtj1neMdz4ebgzI9jp3SL8SXghMLmRgLX0Fm3SWEeEOrXExx0NdvJcbsHOb4YaFmUuu5nT6dNHobpLf8/eSGxyfh7h/Zr9BWRh0yQ6Xv4ty7kOXaAj138qOQZ9F59UcdyWHtDGXLZvMzm/QJ1YrTQoZH0B2XdfurA3N7XjJajAHB3Ihq0wCkbwZKKBRfrUw6gdnS/TMbbsp4MG4BzUJfGaZMCGdMs+05myfb6I8oAT3IDEAFiawQSWS3y3yFWF3k3lnEfzx3LIEwjECrHJ9YbVbVpg7miZjEEcupMjLvEpaDiusgWW59/JNfuFMfGsJKzSP99oK/OqWFfxj0YoFzmSXUgshKUGGgS0PBj3I/bMMDcpud4HfYjPm3Oa3Oryv18Swr6YmLvGTCOo8ZKWFZrUadtgheiXMmLpJmANLEigs5su+V0crku+mo11KJTVzZKs9UxPqr5bBVcJ0F+lcoPtPk0MP933BF3LtbsLY3MZ/kUDOkX3nYMklBHP3DLUqG5iT6N03Y+jJWnD9URypgsoalOyn0U6UYvFEeLKPYkINxv6i0mm08yXyKXz80yfIcebGR4NlGF8ik4wh5/hXIAkLN/BdN4rDs2oUR5SzwSoOZFq049+HoxhvGAW+s4FBHDRv50uAcu/iUezv7dFO5B7MoziCK54XCOw/MZCJwssxoZiFFW/CVX2pcRn6oypgQDz4PPiNaGjqbKFy5ZswNTHMar7WyLjWfBotFsmEd8FwjXPzqoePbBp0RVjUiOqtisCiOBIW8uYqK05Nq6/ndAIKd0Kp3a+dS8fC869eE+fRc/u3TPTvMEt4fkcuudHrC88f2S7eHyEN0XS7fjqNGT1ZdG6TmABPu+Wj5pouNry25smqJ/XGS54ZqzJL8Y0MuO7Qy/Y3V+RQURbPkpKKhCofMbezitRqZ91ZHF3dvpkrlqh2eK9nP2QwtKwsCtAsUVqC/rGZibs3m+ttbc3iaHr79qb/ldv7CQ9vcvvuXlOhQ10E8p+g9eHjWRyNb6f1t6oU4z9I7Nb2rPZ1vsynKhQcqHT6Ptit2W2AwakgHFad9eWhTkE3GDFQKgMur3GiP3RBlmIPMBZ54NNd9IIutAkOxRWhaUgAq3Eogx1sFfNBh3teZ/4RE2OzPfxAMaMpBwahZMBnHMIBhMI2rMZ0EMJVM1KNAPBkjGV01lHFh/j8T1VEWCGmShPIG3NDz/gZYFhqxyBc4YqQo/kYscEdquBo7r3TPB38gk6OKlIPT47uwEuKYNuuWM35abdLh4MdnhxhXZIY+jisw16ZihOBtXwOhGFcxC4FD7ULlW2fuqQDSOKICmVydYVix1cEtdl1glJhllIU1ynQqgL3GuK6KhKPSJUWyzF9GSozFgozx0eiomLkiSrvIpW3cJKzUUmvKRZVNhQpUVq2risS0pX30v0nLXUopfJigZBY61vzKXAFgRr4YwbSuOmcDbmxoGOs+UXO6xLvNxVKuCpAC5AJLGWBBse696VeGjfN82C+SOfVyxe+FjbsISjlADXQIYaUlQVJDWlCVTwWTm5x69cCJdQO0O9XBWjXQw8q8fK5tgK0wXppzZQecSk++/ppjEiUATaAMc8cqDcV+BaF9KCGzxMTbO2///mvBl0rI87rhLkVeJriY8AtFNL91gk8RtwaCrSAap4ixAf6fxadAFJHSvM+V2mlSObuMn6EFYXWVHbRKipvhgxcEXh4nKjsrYmDjTU+rMQ3Ck1vCVQsrgrcL1wJYxvlT+Hl8bp9eAnIx6RBA4UhqNUo83LaVPCKLl9mVaOjIi0xXzlXucEFXbjZnTl/V99JvSnGclAljYvIe5ub+N/CwYfi9VBOXdfzZ9O/RfHdL8Q3XwdChfQyUawl5pdx7zdTyDwZo5Cs0Pka/OZQo3nR34Dp8/HgWSIOxfP+q8/97oHom758+Sh50t/uXxRv/njy/OcOTJ93k94f0ze9P+zb15npf1Qi+e35+J38wwyePCrfvnmn377p67evX1r++tHuQI7l4NmvIpk++jjobYoXT55vvnvdnQye/br57o+fi3eE/NfNdxcXm0l+8GQgdxGmePvmf8Xhx72H+5/3Pu+f7F3tf85+7vCDTx+fXCU/71/sbbff9XV7/3Dw+8dPtnj5KH148EZsP4Z9eC1PNl8kUVMahMyEhPfhqN/Tvt/jYc9IKLaWHfuxysGOSdapXl4rLMgvXCm51VPGR1xIhqzTf6IUgNZK33ymX0fZTYzY2tx8362Y8Og6E/qSHp6oN+VEXYD8a3faXN665ZHUq5yk3jmUSDggGo/mNtv87jZpICm1sNNo5/RLdNXmhWi78Z3T89l5HCFjFebACmWIYm7H0U60sZgSwxYhyrecfnE6WCma4TLFp6FrysYLsXHZjWbx4oylqrkS2lg+EnLUvnHWeb3TYzwNx/C5/dZJi0L8Dpi18OxsQsWRQCkYA8e4HxmIh/yyzgfuhaMKmbqlybf6TBbTaSGbNpcgW/RpS1JejYzXaUg3UQapSiBF9Y6iKsmDf1Zpm9Na8qoMSUiQdCmz0Nvaoiv4T126qz58TNfAre3ZueNw40pEKddmXO8eA+YCVP9pPmCLooUAaS5KWQxSVgYMK+KFECQKOVR05v4cDguQxxiDo2Zddq9fuyFLVF6VPQfwf//zXzQj+Gda5m/ssNSsUBPQ2OJGLV4ZXAmMehGYCDOUVaTkO88zMAZTjdLCyHWniRHVQYRQMuEFH2CTGAaqQlrlao8a1sZ02Osx4CMIDj3QriTkEjK0MCxTivqmMOwprcqbHXBsovTFEEnC5rYBdkNgMGcAwhSQYy4TfJBwKkSBEPaJYXBeaGGAcZEjMPW5DYciEYgY7aLmiWU5l3xEEU1M13/kQhF6GbQa4B3LqKx0twjsqACwbov0INJhT/HWRhvHjylYPPbUXSBM7C5w3kz6PrQBXpYLXF4kYOpCsgwuQZPJcNfvMstYoay7EmNI1zxbRGQ1lwYTDI6gcDQV+3yYT2ukfNph+CqCLgmDXRSATMgLbO1ps9NKzF7DwAgLdepjMplcM18/zs95Juy4HGDgrOp5I/pIxq45vfrxIxob0Lk5HB5jG2cSgqAVa24Q8Ib3ajwhrxaUjRdiaWieiQSkgYYP2n129IJdsoedzShuGOw7ELzxov9k7+B4D/GiS3H61+1sdjYpX6uMzblsLEWtrVWn66LmNp5n1h2x647YdUfsuiO2AbXuiF13xK47YtcdseuO2HVH7Lojdt0Ru+6IXXfErjti1x2x647YdUdszYZ1R+y6I3bdEbvuiF13xK47YtcdseuO2HVH7Lojdt0Ru+6IXXfErjti/790xPrKMAwcN4qMC9motnVFgacLfbLncTTGosGd0+jLF3y0fqWz2Qw/fypBY8XheRxdci0we071hnEorMNStAuYRjvRE/cY0D7B5WMn9lSIslBmiXWBbsYuHf6NsM26xqPD45Mojga+lzdXKc7RfIJ9vnwS7URos6kluCo5p+9foozLUUnVcZHDi/WAvLTj+WLCCyom9H80iuy4nDaonK8ydFvBf3FjSyf8HYtBfofpPypwN7JygudtgMYTPJ/NZv8HXmbasQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\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 "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:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/0028a090.fb02f3a5.js b/assets/js/0028a090.fb02f3a5.js deleted file mode 100644 index 7b232bdb6..000000000 --- a/assets/js/0028a090.fb02f3a5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>f});var i=s(85893),a=s(11151),t=s(58219),r=(s(62316),s(51039)),l=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),p=s(9472),h=s(85162);const m={id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzmuv8Ltl8yoWrKlOJ6MamvreBJPRpn4cmJncrFcCdUNSYy7yQ7Jtqyk9LZfsp+2X3IKINlqyZLtJFOz3jp6SawmCAIgAIIg8CWyfGSi7ll0CnmRcQsmOo+jFEyiRWGFklE3Oh0DC8PsqeZDK+SI7R33GEg+yMCw0oA2zCqWaECgpDRW5eIzjjIbMMfMgL7EudywQVZCoYW0hg2VZiOQoDkhTlVS5oADE2HHrNCQwlBISJmxukxsqcG02KtCSWbKJAFjhmXmVhZKMjVkvFozZnYMRKoGW2ppGGelFJ9KYI2GGnyExPbSRoP9kIIRI8ktpEhcmP5epD/GbDIWyZglXLIBIKspcuoJhhq5A45jStKapoBEDAUCe2QttpemAmnkWTaNGWeNRqmzRoMJwwqtLkUKaVhNDYcoUk6iZUJa0EOeAMkKEIsc0TIBOeMyZUOeiEzYRTGyVBirxaDElVt92ZenouiyV0WmeMqmqtTs+Omvc3CrGH47azSewqAcsVe9RuP8h7G1helubfGiaKkCJEor4wPTSlS+lSJgkQ5JVqABsZK8gBuRTRlPUzYR6QisoQ2RLFHFlCVK6VRIpxoFHwGTZT4AbWLiJlcamJCMMw08nTatapYG2POTo0MUQ85tix1npYmr5VKhIbHZ1KFH8QSuHrjd2d1BHRJyFLOcX6CUhGWfSpFcINsGJG2tV5lWXzLGWF82Gq+R5kpCwng9TxmzY2HYBAZjpS4YXOLwRGQZs1qMRqAbDULy4cMHh+yL+4/wRgTej7qsH3l8/SiuAwQF7UfdfvT06Mmrg/3D0/e9p/2oDjUUGTgsFcirly+WUEmeLwMd7h3sL0Mp66GOM+AGmIZLARPaDtxxx24QxNLkmtNwOJbGEQFog2Nn8+8LMlmm9aT37HD/5XVKvfxyLrIFwP2Dvd6LFZDFWMlFlMe/HR2uwlnqGsbe4TMnyjrUbP7jfIE/v4d7fktPewf7J6d7B8dh+qwvP3z4QPp0UhaF0qhAr51ZdFFR+vIXyNSEcQ2kg4nKcyVZwTXPwZKHHXNLwxo+lUJD6lwkz7JgX11E02SNhp0W0G00WE+mIkETc+5iWgB6SAfdcqBoegh64l2WA60ZJPo055bQ0ibceYkiQ4eEoBrQ21lxCYuIr2I2RcRPARXLoR0rLT4raXlGWnUJ2oqEZ3VngASSC7VckysrlJA2fPUrsLfe6NEnkKl7b4WkpSiuXEgaMcAueVaC8VRNYjZGql5CocGQ5/Z4UZQyZWMQo/Ha9Xj6sTR2ATErTfDHgQq/VtgnEi+Q2IY8M8DEcEGWOb+A2mpMFe6caLFfpiyFIS8zGzOBfszqElrsUFnGiyITCZ2xeCy4A6zU0KRd9grhCUGbQiKO3TmDJ0sq8IxBj4WDhMLPCdShprmDCdkjf2zHXDIllzY6UZnSiH5Jh+j7oiBZoqQFaVts75KLjKh33BomZJKVKbBBxpOLmEKEmGk8FHFbppBlahI7lScQOqpJ6CQgZiBDNVQSGZDKLy/M/DBunaIDqywKx4KoaQ1h6lL1Z8FQ4cIogmBkjFxPTIKL2Uc1YFbYDGI02YLLacxSF3zAlR2oq5glY0gu6C/NU6HYoLRWScdXqlWRqon0shwqaY34vMIiw8jXC7QTs52Y7cbsccza2zFrd2LW3olZezdm7ccx62zHrNOJWWcnZp1dR1bnsRc1r+RbJ6DdcUK2NeGy+y1d9LwvhCHLRpdpKi88WfDCfdlusUajsif6TEc4HVX9CO2LzuQKpB/FzI2h2+xH3XbM/IcrPA4edn4KAFP8vYvSdb8n+LuNu+F+j/F3p92XM79oh4ixPC9uIASH/3wiwk+vT/jRn9b9KLg2/Ig+ycEunt+eLByYzRl6iAwJKazgmVnPU4C4f2zNKVvibAc5I+1dz5aPWu4bT4GsMEK+0w2Rr60NBTdAhHSWRPCoNT9t1kjALXrfBOCp+l7+d5H/ymetF0IFcv8kUSfte8XxU4vCA/Lb64XhAe6fKOaEfa8gHqMg8NxaLwUcvX8i8FSFAR8LuLHtnWb7UbOz3dlZEAPezR1AnjfTtDmdTr9ThO4GjeGRX5+CTR/MuhgQkyBDrfIVNxW6SMyhfPhEf4fo/gBj+gFUeRhMPCymcULKoR6QW5Xy6QPjUIWpVRyH8PMoblojk4aQDkq/JGMlEk88woTobYC3QcpCNFHw6dbBwVZNlO5jM8+DfFn4ir+bJPr61zxvpWlrGXZhh2pfc5amMVvxffVAmrI8z9d9dwN4XPblz2gIPnRbbwse4K8xhxVaP19/ra3MB3iqZEbr0+Vuta0snS9jEXI/Xm/YEoCGUZlxDVd4SzUuqVLLqXy7J1qyomBE8zCfLrV0H3QZRpIE++HIh/I/egVHDhYR4Jfb511jrI5EwwiuCIfLISMxIqXMbozp3jHe+Xi4MaDY50lD+pXwQmByIQNr6SvYpLWKCLdptYs5buryvdyAXWCGGxZmrria0+7TRaO9Teeev5fccPB5iPvn9muUhUGX7HD5uyjnPnSJhjD/W9kx6H50Xs1xV3JIa3PZqsns/AZ7YnOjSSHjA8iu29qdraHOjtesmnBwIBeyyiQQyduBAhrlV0ujfnC2ws4c23UFD849mEmQM8uECemURaHVZ/t8E+UBJbiXiAGwMIENKpX8bpWvCLubzjuP4LfnliUQjhFglesLq92ywsLW1AWDOHIhRV7mVdJyWGENIsv9KV+XF87ER5awQn17r63Ar25Zwb8SrVmgL9uUWghJCXIMbHUw6EHun2eoUXb7EfgtPmPh2PzWA+/rLTHwVbfEFeckgroTsrJCs94MW+wITyXMmLpJmANLEigs5su+10Yrku9mo21KJdVzZOtPpjrUX62D65TpLtq5RPefpoce7vuCL5Ta3ZSxzsZ/kUIukH3nYMklBHP3DLUuG5iT6t03Z+jJWjr6ozhSBdUzKNlLo26UYtVEeKuPYkINxv6i0mnU/RL5FD7+6RPkOHPro8H6iy+RScaQc/wrkIQVG/juG8XhWTWKI8rZYPkGCi3q+ufjKMYbRoHvbGAQB83rfglQ7kE8iv29PepG7qU8iiO44nmBwP4TA5kovBwTillY8SZc1Zc5LkN/VJULiAefB78RDU2dLZWsfBOmOobZXK5zZFxrPo2Wq2PCu2C4xrl51cNHNg22IixaRPVWRWBRHAkLeX2VNbum1ddLOgGFnFBq92vn0rbw/KvXxHn03P4tE/07zAqZ31FKbvT6wotbtof3R0hDNN2cP53GjJ4sWrdpTIAnbvmovqaLDa+tebruSb32kmfGqsxSfCMDrlv0sv3NpThUjcWzpKTqoOqMWOCsIrXirD2Lo6vbmbliiWqG93r2QwZDy8qiAM0SpSXoH+uZuHvDXGdnZxZH09vZm/5XsvcTbt7kdu5eU6HDvAjkP0Hrw8ezOBrfTutvVSnGf5DYnd3Z/KzzZT5VheBApdP3wW/NbgMMhwrCYblZTx7pFHRNEAOlMuDymiR6QxdkKfYAY5EHPt1FL+hCm3CguOozDQlgNQ5lsIOvYj7ocM/rzD9iYmy2jx8oZjTlwCCUDPiMQziAUNGGZZgOQrgyRqoRAJ6MsX7OOqr4EJ//qYoIK8hUaQJ5Y27oGT8DDEvtGIQrXBFytBgj1qRDFRx13lv13cEveMhRKerR6fEdZEkRbNMVs7lz2nHpcLCj02OsSxJDH4e12CtTSSKIli+AMIyL2KXgoXah8u1Tl3QASRJRoYxuXprY8hVBTXadoFSYlRTF8xRoVXp7DfG8HBK3SJUW6zB9/SkzFgqzIEeiohLkqSrvopW3SJKzUUmvKRZNNhQpUVp2XlckpKvrpftPWupQSuXVAiGxyHcupyAVBKrhjxlI46ZzNuTGgo6x2Bclr0u831Qo4aoALUAmsFIEGpzo3pd6Zdy0KIPFIp1XL1/4ItjAQzDKAVqgQwwpKwvSGrKEqngs7Nwy69cCJbQO0O/XBWjXQw8q8fK5tgK0wUJpzZQecSk++8JpjEiUATaAMc8cqHcV+BaF9KCFLxITfO2///mvGl1rI87rhLkVeJriY8AtFNL91ik8RtwaCvSAapEixAf6f5YPAaSOjOZ9rtLKkMzddfwYKwqtqfyiVVTXDBm46u/wOFH5WxMHH2t8WIlvFJreEqhKXBXIL1wJY2vlT+Hl8bp/eAkox6RGA4UhaNWo83JaN/CKLl9mNUdHRVpisXKuOgaXbOHm48ydd/M7qXfFWA6qpHEReWd7G/9b2vhQtR7qqOeF/Nn0b1F89wvxzdeBUEC9ShXnGvPLuPObKWSejFFJ1tj8HPzmUKN+0d+C6fPx4FkijsTz3qvPvfah6JmefPkoedLb7V0Ub/548vznFkyft5POH9M3nT/s29eZ6X1UIvnt+fid/MMMnjwq3755p9++6em3r19a/vrR3kCO5eDZryKZPvo46GyLF0+eb7973Z4Mnv26/e6Pn4t3hPzX7XcXF9tJfvhkIPcQpnj75n/F0cf9hwef9z8fnO5fHXzOfm7xw08fn1wlPx9c7O823/V08+Bo8PvHT7Z4+Sh9ePhG7D6GA3gtT7dfJFFdG4TMhIT3YavfE9/vcbNnpBQ7q7b9ROVgx6TrVCivFVbiF67U3Oop4yMuJEPR6T9RC0BrpW/e06+j7CZB7Gxvv29XQnh0XQg9SQ9P1JRyqi5A/rWc1pe3bnkk9SonrXcHSiQcEI1HC8zWvzsmDSSlFnYadc++RFdNXoimG++enc/O4wgFqzAHVihDFHM7jrrR1nJKDHuDKN9y9sXZYGVohssUn4auGRsvxNZlO5rFyzNWmuZaaGP5SMhR88ZZ53NOT3A3nMAX+J0nLQrxO2DWwouzDhVHArVgDBzjfhQgbvLLeT5wP2xVyNStTL7N92Q5nRayaQsJsuUzbUXKq5bxOgvpJsogVQmkaM5RVCV58M8qbXM217wqQxISJG3KLHR2dugK/lOb7qoPH9M1cGd3du4kXLsSUcq1Hte7x4CFANV/WgzYomgpQFqIUpaDlLUBw5p4IQSJQg4V7bnfh6MC5AnG4GhZl+3r127IEpVXZc8B/N///BfNCOczLfM3dlRqVqgJaOxto96uDK4ERr0ITIQZyipS8p3nGRiDqUZpYeTa0sSI6iBCKJnwgg+wOwwDVSGtcrVHNW9jWuz1GPARBIceaFcScgkZehiWKUUNUxj2lFbl9dY3NlH6YogkYVfbALshMJgzAGEKyDGXCT5IOBOiQAgbxDA4L7QwwLjIEZga3IZDkQhEjH5R88SynEs+oogmpus/SqEIvQxaDfCOZVRWulsEdlQAWMciPYi02FO8tRHj+DEFi9ueuguEid0FzrtJ34A2wMtygcuLBMy8kCyDS9DkMtz1u8wyVijrrsQY0tX3FhFZzaXBBIMjKGxNJT4f5tMaKZ+2GL6K4JGEwS4qQCbkBbb2NNlZpWavYWCEhXnqYzKZXHNfPy7OeSbsuBxg4Kzm80b0kZxdfXr140d0NqBzczQ8wf7NJARBa9bcIuAtf6rxhE61YGy8ECtD80wkIA3UzqC9Z8cv2CV72NqO4prDvgPBWy96T/YPT/YRLx4pzv7are3WNuVrlbE5l7WlqKe1anFdttza88ymFXbTCrtphd20wm5aYRnbtMJuWmE3rbCbVthNK+ymFXbTCrtphe1vWmH7m1bYTSvsphV20wo7F8OmFXbTCrtphd20wm5aYTetsJtW2E0r7KYVdtMKu2mF3bTCblphN62w/19aYX1JGAaOW0XGhayV2bpqwLOlBtnzOBpjtWD3LPryBV+rX+lsNsPPn0rQWGp4HkeXXAvMnlOhYRwq6rAG7QKmUTd64h4Dmqe4fOzUnipQluorsSDQzdijzb8Rtl7QeHx0chrF0cA38eYqxTmaT7DBl0+iboQ+m3qBq1pz+v4lyrgclVQWFzm8WAjISzterCK8oCpC/0etuo7LaY3KxfJCxwr+i4ytnPB3rAL5Hab/qMDdyNoJXrYBGnfwfDab/R9HjNg1",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",source:"@site/docs/API-docs/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.",sidebar_label:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztO9tyGzmuv8Ltl8yoWrKlOJ6MamvreBJPRpn4cmJncrFcCdUNSYy7yQ7Jtqyk9LZfsp+2X3IKINlqyZLtJFOz3jp6SawmCAIgAIIg8CWyfGSi7ll0CnmRcQsmOo+jFEyiRWGFklE3Oh0DC8PsqeZDK+SI7R33GEg+yMCw0oA2zCqWaECgpDRW5eIzjjIbMMfMgL7EudywQVZCoYW0hg2VZiOQoDkhTlVS5oADE2HHrNCQwlBISJmxukxsqcG02KtCSWbKJAFjhmXmVhZKMjVkvFozZnYMRKoGW2ppGGelFJ9KYI2GGnyExPbSRoP9kIIRI8ktpEhcmP5epD/GbDIWyZglXLIBIKspcuoJhhq5A45jStKapoBEDAUCe2QttpemAmnkWTaNGWeNRqmzRoMJwwqtLkUKaVhNDYcoUk6iZUJa0EOeAMkKEIsc0TIBOeMyZUOeiEzYRTGyVBirxaDElVt92ZenouiyV0WmeMqmqtTs+Omvc3CrGH47azSewqAcsVe9RuP8h7G1helubfGiaKkCJEor4wPTSlS+lSJgkQ5JVqABsZK8gBuRTRlPUzYR6QisoQ2RLFHFlCVK6VRIpxoFHwGTZT4AbWLiJlcamJCMMw08nTatapYG2POTo0MUQ85tix1npYmr5VKhIbHZ1KFH8QSuHrjd2d1BHRJyFLOcX6CUhGWfSpFcINsGJG2tV5lWXzLGWF82Gq+R5kpCwng9TxmzY2HYBAZjpS4YXOLwRGQZs1qMRqAbDULy4cMHh+yL+4/wRgTej7qsH3l8/SiuAwQF7UfdfvT06Mmrg/3D0/e9p/2oDjUUGTgsFcirly+WUEmeLwMd7h3sL0Mp66GOM+AGmIZLARPaDtxxx24QxNLkmtNwOJbGEQFog2Nn8+8LMlmm9aT37HD/5XVKvfxyLrIFwP2Dvd6LFZDFWMlFlMe/HR2uwlnqGsbe4TMnyjrUbP7jfIE/v4d7fktPewf7J6d7B8dh+qwvP3z4QPp0UhaF0qhAr51ZdFFR+vIXyNSEcQ2kg4nKcyVZwTXPwZKHHXNLwxo+lUJD6lwkz7JgX11E02SNhp0W0G00WE+mIkETc+5iWgB6SAfdcqBoegh64l2WA60ZJPo055bQ0ibceYkiQ4eEoBrQ21lxCYuIr2I2RcRPARXLoR0rLT4raXlGWnUJ2oqEZ3VngASSC7VckysrlJA2fPUrsLfe6NEnkKl7b4WkpSiuXEgaMcAueVaC8VRNYjZGql5CocGQ5/Z4UZQyZWMQo/Ha9Xj6sTR2ATErTfDHgQq/VtgnEi+Q2IY8M8DEcEGWOb+A2mpMFe6caLFfpiyFIS8zGzOBfszqElrsUFnGiyITCZ2xeCy4A6zU0KRd9grhCUGbQiKO3TmDJ0sq8IxBj4WDhMLPCdShprmDCdkjf2zHXDIllzY6UZnSiH5Jh+j7oiBZoqQFaVts75KLjKh33BomZJKVKbBBxpOLmEKEmGk8FHFbppBlahI7lScQOqpJ6CQgZiBDNVQSGZDKLy/M/DBunaIDqywKx4KoaQ1h6lL1Z8FQ4cIogmBkjFxPTIKL2Uc1YFbYDGI02YLLacxSF3zAlR2oq5glY0gu6C/NU6HYoLRWScdXqlWRqon0shwqaY34vMIiw8jXC7QTs52Y7cbsccza2zFrd2LW3olZezdm7ccx62zHrNOJWWcnZp1dR1bnsRc1r+RbJ6DdcUK2NeGy+y1d9LwvhCHLRpdpKi88WfDCfdlusUajsif6TEc4HVX9CO2LzuQKpB/FzI2h2+xH3XbM/IcrPA4edn4KAFP8vYvSdb8n+LuNu+F+j/F3p92XM79oh4ixPC9uIASH/3wiwk+vT/jRn9b9KLg2/Ig+ycEunt+eLByYzRl6iAwJKazgmVnPU4C4f2zNKVvibAc5I+1dz5aPWu4bT4GsMEK+0w2Rr60NBTdAhHSWRPCoNT9t1kjALXrfBOCp+l7+d5H/ymetF0IFcv8kUSfte8XxU4vCA/Lb64XhAe6fKOaEfa8gHqMg8NxaLwUcvX8i8FSFAR8LuLHtnWb7UbOz3dlZEAPezR1AnjfTtDmdTr9ThO4GjeGRX5+CTR/MuhgQkyBDrfIVNxW6SMyhfPhEf4fo/gBj+gFUeRhMPCymcULKoR6QW5Xy6QPjUIWpVRyH8PMoblojk4aQDkq/JGMlEk88woTobYC3QcpCNFHw6dbBwVZNlO5jM8+DfFn4ir+bJPr61zxvpWlrGXZhh2pfc5amMVvxffVAmrI8z9d9dwN4XPblz2gIPnRbbwse4K8xhxVaP19/ra3MB3iqZEbr0+Vuta0snS9jEXI/Xm/YEoCGUZlxDVd4SzUuqVLLqXy7J1qyomBE8zCfLrV0H3QZRpIE++HIh/I/egVHDhYR4Jfb511jrI5EwwiuCIfLISMxIqXMbozp3jHe+Xi4MaDY50lD+pXwQmByIQNr6SvYpLWKCLdptYs5buryvdyAXWCGGxZmrria0+7TRaO9Teeev5fccPB5iPvn9muUhUGX7HD5uyjnPnSJhjD/W9kx6H50Xs1xV3JIa3PZqsns/AZ7YnOjSSHjA8iu29qdraHOjtesmnBwIBeyyiQQyduBAhrlV0ujfnC2ws4c23UFD849mEmQM8uECemURaHVZ/t8E+UBJbiXiAGwMIENKpX8bpWvCLubzjuP4LfnliUQjhFglesLq92ywsLW1AWDOHIhRV7mVdJyWGENIsv9KV+XF87ER5awQn17r63Ar25Zwb8SrVmgL9uUWghJCXIMbHUw6EHun2eoUXb7EfgtPmPh2PzWA+/rLTHwVbfEFeckgroTsrJCs94MW+wITyXMmLpJmANLEigs5su+10Yrku9mo21KJdVzZOtPpjrUX62D65TpLtq5RPefpoce7vuCL5Ta3ZSxzsZ/kUIukH3nYMklBHP3DLUuG5iT6t03Z+jJWjr6ozhSBdUzKNlLo26UYtVEeKuPYkINxv6i0mnU/RL5FD7+6RPkOHPro8H6iy+RScaQc/wrkIQVG/juG8XhWTWKI8rZYPkGCi3q+ufjKMYbRoHvbGAQB83rfglQ7kE8iv29PepG7qU8iiO44nmBwP4TA5kovBwTillY8SZc1Zc5LkN/VJULiAefB78RDU2dLZWsfBOmOobZXK5zZFxrPo2Wq2PCu2C4xrl51cNHNg22IixaRPVWRWBRHAkLeX2VNbum1ddLOgGFnFBq92vn0rbw/KvXxHn03P4tE/07zAqZ31FKbvT6wotbtof3R0hDNN2cP53GjJ4sWrdpTIAnbvmovqaLDa+tebruSb32kmfGqsxSfCMDrlv0sv3NpThUjcWzpKTqoOqMWOCsIrXirD2Lo6vbmbliiWqG93r2QwZDy8qiAM0SpSXoH+uZuHvDXGdnZxZH09vZm/5XsvcTbt7kdu5eU6HDvAjkP0Hrw8ezOBrfTutvVSnGf5DYnd3Z/KzzZT5VheBApdP3wW/NbgMMhwrCYblZTx7pFHRNEAOlMuDymiR6QxdkKfYAY5EHPt1FL+hCm3CguOozDQlgNQ5lsIOvYj7ocM/rzD9iYmy2jx8oZjTlwCCUDPiMQziAUNGGZZgOQrgyRqoRAJ6MsX7OOqr4EJ//qYoIK8hUaQJ5Y27oGT8DDEvtGIQrXBFytBgj1qRDFRx13lv13cEveMhRKerR6fEdZEkRbNMVs7lz2nHpcLCj02OsSxJDH4e12CtTSSKIli+AMIyL2KXgoXah8u1Tl3QASRJRoYxuXprY8hVBTXadoFSYlRTF8xRoVXp7DfG8HBK3SJUW6zB9/SkzFgqzIEeiohLkqSrvopW3SJKzUUmvKRZNNhQpUVp2XlckpKvrpftPWupQSuXVAiGxyHcupyAVBKrhjxlI46ZzNuTGgo6x2Bclr0u831Qo4aoALUAmsFIEGpzo3pd6Zdy0KIPFIp1XL1/4ItjAQzDKAVqgQwwpKwvSGrKEqngs7Nwy69cCJbQO0O/XBWjXQw8q8fK5tgK0wUJpzZQecSk++8JpjEiUATaAMc8cqHcV+BaF9KCFLxITfO2///mvGl1rI87rhLkVeJriY8AtFNL91ik8RtwaCvSAapEixAf6f5YPAaSOjOZ9rtLKkMzddfwYKwqtqfyiVVTXDBm46u/wOFH5WxMHH2t8WIlvFJreEqhKXBXIL1wJY2vlT+Hl8bp/eAkox6RGA4UhaNWo83JaN/CKLl9mNUdHRVpisXKuOgaXbOHm48ydd/M7qXfFWA6qpHEReWd7G/9b2vhQtR7qqOeF/Nn0b1F89wvxzdeBUEC9ShXnGvPLuPObKWSejFFJ1tj8HPzmUKN+0d+C6fPx4FkijsTz3qvPvfah6JmefPkoedLb7V0Ub/548vznFkyft5POH9M3nT/s29eZ6X1UIvnt+fid/MMMnjwq3755p9++6em3r19a/vrR3kCO5eDZryKZPvo46GyLF0+eb7973Z4Mnv26/e6Pn4t3hPzX7XcXF9tJfvhkIPcQpnj75n/F0cf9hwef9z8fnO5fHXzOfm7xw08fn1wlPx9c7O823/V08+Bo8PvHT7Z4+Sh9ePhG7D6GA3gtT7dfJFFdG4TMhIT3YavfE9/vcbNnpBQ7q7b9ROVgx6TrVCivFVbiF67U3Oop4yMuJEPR6T9RC0BrpW/e06+j7CZB7Gxvv29XQnh0XQg9SQ9P1JRyqi5A/rWc1pe3bnkk9SonrXcHSiQcEI1HC8zWvzsmDSSlFnYadc++RFdNXoimG++enc/O4wgFqzAHVihDFHM7jrrR1nJKDHuDKN9y9sXZYGVohssUn4auGRsvxNZlO5rFyzNWmuZaaGP5SMhR88ZZ53NOT3A3nMAX+J0nLQrxO2DWwouzDhVHArVgDBzjfhQgbvLLeT5wP2xVyNStTL7N92Q5nRayaQsJsuUzbUXKq5bxOgvpJsogVQmkaM5RVCV58M8qbXM217wqQxISJG3KLHR2dugK/lOb7qoPH9M1cGd3du4kXLsSUcq1Hte7x4CFANV/WgzYomgpQFqIUpaDlLUBw5p4IQSJQg4V7bnfh6MC5AnG4GhZl+3r127IEpVXZc8B/N///BfNCOczLfM3dlRqVqgJaOxto96uDK4ERr0ITIQZyipS8p3nGRiDqUZpYeTa0sSI6iBCKJnwgg+wOwwDVSGtcrVHNW9jWuz1GPARBIceaFcScgkZehiWKUUNUxj2lFbl9dY3NlH6YogkYVfbALshMJgzAGEKyDGXCT5IOBOiQAgbxDA4L7QwwLjIEZga3IZDkQhEjH5R88SynEs+oogmpus/SqEIvQxaDfCOZVRWulsEdlQAWMciPYi02FO8tRHj+DEFi9ueuguEid0FzrtJ34A2wMtygcuLBMy8kCyDS9DkMtz1u8wyVijrrsQY0tX3FhFZzaXBBIMjKGxNJT4f5tMaKZ+2GL6K4JGEwS4qQCbkBbb2NNlZpWavYWCEhXnqYzKZXHNfPy7OeSbsuBxg4Kzm80b0kZxdfXr140d0NqBzczQ8wf7NJARBa9bcIuAtf6rxhE61YGy8ECtD80wkIA3UzqC9Z8cv2CV72NqO4prDvgPBWy96T/YPT/YRLx4pzv7are3WNuVrlbE5l7WlqKe1anFdttza88ymFXbTCrtphd20wm5aYRnbtMJuWmE3rbCbVthNK+ymFXbTCrtphe1vWmH7m1bYTSvsphV20wo7F8OmFXbTCrtphd20wm5aYTetsJtW2E0r7KYVdtMKu2mF3bTCblphN62w/19aYX1JGAaOW0XGhayV2bpqwLOlBtnzOBpjtWD3LPryBV+rX+lsNsPPn0rQWGp4HkeXXAvMnlOhYRwq6rAG7QKmUTd64h4Dmqe4fOzUnipQluorsSDQzdijzb8Rtl7QeHx0chrF0cA38eYqxTmaT7DBl0+iboQ+m3qBq1pz+v4lyrgclVQWFzm8WAjISzterCK8oCpC/0etuo7LaY3KxfJCxwr+i4ytnPB3rAL5Hab/qMDdyNoJXrYBGnfwfDab/R9HjNg1",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},g={},f=[{value:"Request",id:"request",level:2}];function j(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,a.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(n.p,{children:"Draft Template"})}),"\n",(0,i.jsx)(l(),{method:"post",path:"/drafttemplate"}),"\n",(0,i.jsxs)(n.p,{children:["The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique ",(0,i.jsx)(n.strong,{children:"objectId"})," (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a ",(0,i.jsx)(n.strong,{children:"url"})," is provided, which offers a user interface for editing the template and facilitating document distribution."]}),"\n",(0,i.jsxs)(n.p,{children:["Tip: Upload your PDF document to our ",(0,i.jsx)(n.a,{href:"https://app.opensignlabs.com/debugpdf",children:(0,i.jsx)(n.strong,{children:"Debug UI"})}),", where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"When document is created this webhook event will trigger"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:' {\n "event": "created",\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:"Supported Widgets:"})}),"\n",(0,i.jsx)(n.p,{children:"Below are the common parameters that are required with all widgets:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"type:"})," Indicates the type of widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"page:"})," Specifies the page number on which you want to place the respective widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"x, y:"})," Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"w, h:"})," Represents the width and height of the widget. You can adjust these values using the debug UI."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"required:"})," Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"name:"})," Provides a different name for widgets if you are providing more than one widget."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"color:"})," Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified.This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"fontsize:"})," Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"List of all supported widgets:"})}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"signature:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"signature", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"2",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"stamp:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"stamp", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "stamp"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"3",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"initials:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"initials", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "initials"\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"4",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"email:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"email", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "email",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"5",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"name:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"name", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "name",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"6",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"job title:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"job title", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "job title",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"7",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"company:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"company", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "company",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ol,{start:"8",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"date:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"date", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "date",\n "default": "04-15-2024",\n "format": "mm-dd-yyyy",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"format:"})," Specify the date format of your choice from the options below.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:'"dd/MM/yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd-mm-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"yyyy-mm-dd",'}),"\n",(0,i.jsx)(n.li,{children:'"mm.dd.yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mm-dd-yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"mmmm dd, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmm, yyyy",'}),"\n",(0,i.jsx)(n.li,{children:'"dd mmmm, yyy"'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"9",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"textbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"textbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": { \n "name": "textbox",\n "required": true,\n "readonly": false,\n "default": "name",\n "hint": "provide name",\n "regularexpression":"",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide a default value for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hint:"})," Provide a hint for the textbox (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"regularexpression:"})," Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the textbox as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"10",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"checkbox:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"checkbox", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "checkbox",\n "values": ["male", "female", "other"],\n "selectedvalues": [ "male", "female" ],\n "readonly": false, \n "hidelabel": false,\n "color": "black",\n "fontsize": 12,\n "validation": {\n "minselections": 0, \n "maxselections": 0 \n }\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the checkbox list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"selectedvalues:"})," Provide values that need to be selected by default (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the checkbox as readonly. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"hidelabel:"})," Set to true if you want to hide labels of the checkbox. By default, it's false."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"minselections:"})," Provide the minimum number of checkboxes that must be selected by the user."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"maxselections:"})," Provide the maximum number of checkboxes that can be selected by the user."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"11",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"dropdown:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"dropdown", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "dropdown",\n "readonly": false,\n "values": ["male", "female", "other"],\n "default": "",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the dropdown list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the dropdown as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"12",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"radio button:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"radio button", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "readonly": false,\n "required": true, \n "name": "radio button",\n "values": ["male", "female", "other"],\n "default": "male",\n "color": "black",\n "fontsize": 12\n }\n}\n'})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"values:"})," Provide options for the radio button list."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"default:"})," Provide the value that needs to be selected by default. Only one value is accepted. (Optional)."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"readonly:"})," Set to true if you want to set the radio button as readonly. By default, it's false."]}),"\n"]}),"\n",(0,i.jsxs)(n.ol,{start:"13",children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.strong,{children:"image:"})}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n "type":"image", \n "page":1, \n "x": 327, \n "y": 628, \n "w": 114, \n "h": 21, \n "options": {\n "required": true, \n "name": "image"\n }\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(n.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(n.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"You can provide signer optionally if you it as default signer"})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ceo"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(n.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(n.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(n.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"The page number on which the widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"x co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:244}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"y co-ordinate (left upper corner) from which widget should appear. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:71}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Width of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:38}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Height of widget. use our [**Debug UI**](https://app.opensignlabs.com/debugpdf) to calculate the value.",format:"number",example:46}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(n.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Specifies the URL where the signer will be redirected upon completing the document signing process.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The name of the person or organization on whose behalf the email is being sent.",example:"opensign\u2122"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sender_email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"The email address of the person or organization that users can reply to.",example:"mailer@opensignlabs.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Template created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bh2Hspnmch"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "Bh2Hspnmch",\n "url": "https://app.opensignlabs.com/drafttemplate/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2VtYWlsIjoicHJhZnVsbC5uYXZrYXIrYWRtaW5AbnhnbGFicy5jb20iLCJ0ZW1wbGF0ZV9pZCI6IkF0Zkk0cmNCbnAiLCJpYXQiOjE3MzEzMTExMzl9.aNqjCxc9MkE6-ZIr-MObKjqtpR5d3NXi68eMeWnT0Lc"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(n.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(n.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.9bc6455d.js b/assets/js/70853c19.9bc6455d.js deleted file mode 100644 index 473cd2535..000000000 --- a/assets/js/70853c19.9bc6455d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>E,frontMatter:()=>p,metadata:()=>j,toc:()=>g});var a=n(85893),l=n(11151),i=n(58219),r=(n(62316),n(51039)),t=n.n(r),o=(n(82723),n(9487)),d=(n(41429),n(5397)),c=n(4667),h=n(9472),m=n(85162);const p={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA7TXYC3JqQschENR19GlQuM/iGT4gyU41O5oxZpLbkmuZEHQt3uSe7R7ksOQu9JKdhUHMVK3UT7E9vI3w5nhj0NyZsEcTy1rX7MrHE20vmXDiCVoYyNyJ7RibdafIFg+RdAGijzhDqHEwvFFF7iUegZzXYDTATcrRwsjYTYR8QSEhcJiQghnRJqiAZyicnagXr58Wf7eHqiBOmzAq1dTgTNM2q9eDRQAwAFcTVCBFalCA2EQEh0XGSoHbiJs0AAzIWU1QSPIfvjwIfyyCD/o34B5+IC1YcCCugGL6uN69BvGrpsMWHvA3pyfXJ52zvo33TcDVkeNhcSgZAW5fP9uS5Xi2Tbo7Pi0s43SrkRdSOQWwSAZBlwl3u/gZeXzlnBtuYKOrfEQOEtj1+vvGyHZtrXXfXvWeX/f0jJ8GRdyA9g5Pe6+ewCZT7TaVHnxy/lZpx5HgOX6j+GG4WFtfp5/ZKoKeFwuab972un1j08vtlCxQe4ehFWo5UC9JgKWyG0GrjgnLJSQz6VfqWbPv+fIv0cRhpBqJ0GMLtIJJIaPHTjMckkplFLnnjt/Se7cQxamprF79jaE8kkpBgP1PWUmH4+diSkgYDSvDszPZFnQ9xWQzA/VV/bZ5KctsZrRn33mLYlZR/7M01ku8SOn3ppcXMqSYPYjDHtEIqum/gpY9rxS2eNyFBonxiLmVXBOOu/73X93T477nQdCvVrNJ7mPeaj6gRiaYCzFR7JfhXm6/Fdp3HPzOXKzWp1HPBIq6JPQkkVM52g4RbSbsDajl+834XlcvaQjZvD3Aq37WSdz1l5svasvjJ6KBP0z2enyvghr4Vgrh8qRIM9zSftPaNX8zZL0gtl4ghmn32gWYTChV/ylkfSCd/McWbskKYtYbshaJ9CSQGEk/ShB1hmhUhaxsTYZd/UveMdpL7M2mziX23azOdeFOSgf+AeFkT+VkEasM7ZcRswJ5wVKzM2IfF8uacigzbWywYbXrdb9kPSKOEZrx4WEVXQ/JRK73TZoC+ke8nztZ1XZCCuZgF1ZJOcvNhwUith0Uzl187rVuvln6enRg87pDN1EqBRmPhcZrdII8rCZnZkDT7lQQK8D8+LpvEZjtNnt9KdZtisIR63WzeEqCIf3g3BVqw1xaZAnc8A7YZ39si7vsmO3g4c3s5WDR/cdvLRoQGkHY12o5Ms6tT33bkeOVm78cN+NrppyKRL/TO3rW1Rf1pP69C5MT6beZT5x0SHkXfIgP842XK1/D05ajAsj3Jy1rxfs7oDn4iCMt6+Hy2HEaANoyuO5tt5i7iaszZqzVTq2aKZorFfgE+gqJ1qukpG+a+gcFR2kko8s5cMmz0VzesiW0bYEz/NPQFvHU6HSg51Sw7WPPVqHEOoNT1cB57n4FecsqgJZR0VM0PpPkCdofNBped+vD7JOtUjbZu4+GkjvWHsjymU6z1H16OJCizw9ZNt15yuUsc7QF40nCBX8f//5r5eobjqegy/gvDCQ6xkaOjzoTjSWeCdGEtdFaruqUiPPJFor5yCUw9TQwZuIVDgeHjWUCmOe85GQglhLME3SBmrEtw26f7oJGhr61iBwSHCKksgOUutb0uM08MLpzM9R3VRn2tyOyaQIOIwKKxRaCxaxEkE14SpGqNY0ouo7V4DKocmNsAhcZAQeawM4HotYkGLaoobHDjKueIo0WQRkN0UhDzcOC0aPCuvAall4R2jGDNEFFxViYhvwRkwxOE4fE3RcSEwgLUhFBLFOEMolJjdUAiO0DnKaXsTolVrHjQOJUzSew34l6TCFXFMqEVyCHm+sLSlyhitL15FgULU0q/DlRtOp7OdI+LwB1DqgU4zaDEQAKdQtNRQO4HpFsyscWeFw+I+KsLPZ7N5++m5T5q1wk2IEBnO9lkv9R7/76uKrP75jEXNoMns+7qGZiri6QP3BnE0PbpYJlsc+wfoLdNirP20L0G6SIkZlsZYOj99evIMpfN9osai2NR9hcPNd96Rz1uuQXspxYf8dNlqNFn2ilJhxVZuqV7aDLjfaQds7eLE+MPZNpP0Lcd9E2jeRvkL+7ZtIe+7sm0j7JtKfwLF9E+lvyrLnlcr2TaR9E+kvzc0/sYlUVuQc3rlmLrnwhcyyPxNqkNdVK4X6OhOqTrav2WIx4hYvjVwu6fPvBRoqbQ4jNuVG8BEV2K6Hy6iq41HR8hbnrM1OwpP8oE8TE1wWoSS4Vc+lMmSQOI5jzN1ObL2AenHe67OIjcqeV6YTkjF8Rv0wPmNtRsTx/TNfe/KdGfq+YJKrtOAp4YNeKj/ygqJQr13e+tpl+Qt5Vg2pec3KzaJmcIX+J8ceFPgX3aZ/xfmPK3gY+UOBMrYVmtZuuFwu/w8wgvPn",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save 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:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWe9uGzcSf5UJA7TXYC3JqQschENR19GlQuM/iGT4gyU41O5oxZpLbkmuZEHQt3uSe7R7ksOQu9JKdhUHMVK3UT7E9vI3w5nhj0NyZsEcTy1rX7MrHE20vmXDiCVoYyNyJ7RibdafIFg+RdAGijzhDqHEwvFFF7iUegZzXYDTATcrRwsjYTYR8QSEhcJiQghnRJqiAZyicnagXr58Wf7eHqiBOmzAq1dTgTNM2q9eDRQAwAFcTVCBFalCA2EQEh0XGSoHbiJs0AAzIWU1QSPIfvjwIfyyCD/o34B5+IC1YcCCugGL6uN69BvGrpsMWHvA3pyfXJ52zvo33TcDVkeNhcSgZAW5fP9uS5Xi2Tbo7Pi0s43SrkRdSOQWwSAZBlwl3u/gZeXzlnBtuYKOrfEQOEtj1+vvGyHZtrXXfXvWeX/f0jJ8GRdyA9g5Pe6+ewCZT7TaVHnxy/lZpx5HgOX6j+GG4WFtfp5/ZKoKeFwuab972un1j08vtlCxQe4ehFWo5UC9JgKWyG0GrjgnLJSQz6VfqWbPv+fIv0cRhpBqJ0GMLtIJJIaPHTjMckkplFLnnjt/Se7cQxamprF79jaE8kkpBgP1PWUmH4+diSkgYDSvDszPZFnQ9xWQzA/VV/bZ5KctsZrRn33mLYlZR/7M01ku8SOn3ppcXMqSYPYjDHtEIqum/gpY9rxS2eNyFBonxiLmVXBOOu/73X93T477nQdCvVrNJ7mPeaj6gRiaYCzFR7JfhXm6/Fdp3HPzOXKzWp1HPBIq6JPQkkVM52g4RbSbsDajl+834XlcvaQjZvD3Aq37WSdz1l5svasvjJ6KBP0z2enyvghr4Vgrh8qRIM9zSftPaNX8zZL0gtl4ghmn32gWYTChV/ylkfSCd/McWbskKYtYbshaJ9CSQGEk/ShB1hmhUhaxsTYZd/UveMdpL7M2mziX23azOdeFOSgf+AeFkT+VkEasM7ZcRswJ5wVKzM2IfF8uacigzbWywYbXrdb9kPSKOEZrx4WEVXQ/JRK73TZoC+ke8nztZ1XZCCuZgF1ZJOcvNhwUith0Uzl187rVuvln6enRg87pDN1EqBRmPhcZrdII8rCZnZkDT7lQQK8D8+LpvEZjtNnt9KdZtisIR63WzeEqCIf3g3BVqw1xaZAnc8A7YZ39si7vsmO3g4c3s5WDR/cdvLRoQGkHY12o5Ms6tT33bkeOVm78cN+NrppyKRL/TO3rW1Rf1pP69C5MT6beZT5x0SHkXfIgP842XK1/D05ajAsj3Jy1rxfs7oDn4iCMt6+Hy2HEaANoyuO5tt5i7iaszZqzVTq2aKZorFfgE+gqJ1qukpG+a+gcFR2kko8s5cMmz0VzesiW0bYEz/NPQFvHU6HSg51Sw7WPPVqHEOoNT1cB57n4FecsqgJZR0VM0PpPkCdofNBped+vD7JOtUjbZu4+GkjvWHsjymU6z1H16OJCizw9ZNt15yuUsc7QF40nCBX8f//5r5eobjqegy/gvDCQ6xkaOjzoTjSWeCdGEtdFaruqUiPPJFor5yCUw9TQwZuIVDgeHjWUCmOe85GQglhLME3SBmrEtw26f7oJGhr61iBwSHCKksgOUutb0uM08MLpzM9R3VRn2tyOyaQIOIwKKxRaCxaxEkE14SpGqNY0ouo7V4DKocmNsAhcZAQeawM4HotYkGLaoobHDjKueIo0WQRkN0UhDzcOC0aPCuvAall4R2jGDNEFFxViYhvwRkwxOE4fE3RcSEwgLUhFBLFOEMolJjdUAiO0DnKaXsTolVrHjQOJUzSew34l6TCFXFMqEVyCHm+sLSlyhitL15FgULU0q/DlRtOp7OdI+LwB1DqgU4zaDEQAKdQtNRQO4HpFsyscWeFw+I+KsLPZ7N5++m5T5q1wk2IEBnO9lkv9R7/76uKrP75jEXNoMns+7qGZiri6QP3BnE0PbpYJlsc+wfoLdNirP20L0G6SIkZlsZYOj99evIMpfN9osai2NR9hcPNd96Rz1uuQXspxYf8dNlqNFn2ilJhxVZuqV7aDLjfaQds7eLE+MPZNpP0Lcd9E2jeRvkL+7ZtIe+7sm0j7JtKfwLF9E+lvyrLnlcr2TaR9E+kvzc0/sYlUVuQc3rlmLrnwhcyyPxNqkNdVK4X6OhOqTrav2WIx4hYvjVwu6fPvBRoqbQ4jNuVG8BEV2K6Hy6iq41HR8hbnrM1OwpP8oE8TE1wWoSS4Vc+lMmSQOI5jzN1ObL2AenHe67OIjcqeV6YTkjF8Rv0wPmNtRsTx/TNfe/KdGfq+YJKrtOAp4YNeKj/ygqJQr13e+tpl+Qt5Vg2pec3KzaJmcIX+J8ceFPgX3aZ/xfmPK3gY+UOBMrYVmtZuuFwu/w8wgvPn",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"}},x={},g=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(s.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "viewed",\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"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"created:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "created",\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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsxs)(s.li,{children:["When document is created through draft template API this event will trigger.","\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "created",\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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.ol,{start:"3",children:["\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"signed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "signed",\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 {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"completed:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "completed",\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'})}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:[(0,a.jsx)(s.strong,{children:"declined:"}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(s.pre,{children:(0,a.jsx)(s.code,{children:'{\n "event": "declined",\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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(s.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(s.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(m.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(m.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(m.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function E(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.cd323a0c.js b/assets/js/70853c19.cd323a0c.js new file mode 100644 index 000000000..ad81ed6a2 --- /dev/null +++ b/assets/js/70853c19.cd323a0c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>E,frontMatter:()=>m,metadata:()=>x,toc:()=>v});var a=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),t=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),h=s(9472),p=s(85162);const m={id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWf9uGzcSfpUJA/SuwVqSUxc4CEVR19HlhMY/EMkwCktwqN3RLmsuuSW5kgVB/92T3KPdkxyGuyut1q7iIEbqa+Q/LIn8hpwZfhySM0vmeGxZ95pd4STR+paNAxahDY3InNCKddkwQbB8hqAN5FnEHUKJheOLPnAp9RwWOgenC9y87M2NhHkiwgSEhdxiRAhnRByjAZyhcnakXr58WX7vjtRIHbbg1auZwDlG3VevRgoA4ACuElRgRazQQNEJkQ7zFJUDlwhbjABzIWU1QauQ/fDhQ/FlWXzQ34h5+Ih1YcSK4UYsqPe7RYZF95vzk8vT3tnwZvjrRa+B0pPfMHT9qIHsvxmxOmwqZHOwy/fvGmMpnjZBZ8enzRmVdiXqQiK3CAZJf+Aq8u4pnFG5piFc+M+S/PWmfcszTV0G/bdnvff3NSm9mHIht4C90+P+uweQWaLV9pAX/zo/69X9BLDa/BhvKV4s0c+Lj0xVAY/LlR32T3uD4fHpRQMVGuTuQViFWo3Ua+JhiWwScU09YaGEfC4Ly2H2NHzGNHwUbwipdvLE6DxOIDJ86sBhmkkKqBRI9xT6f6bQPWRuaiP2z94WrnpSpsFIfUdxyvtjZ5gqEDBZVKfoZ5KtGO/r4ZoXry/ws4lWDbGa0p99EK6IYEf+INRpJvEjR+GGY1zKkmf2I0R7RFirpv56yPa8AtvjIhYaJ6Yi5JXxJ733w/4/+yfHw94Drlwv6pPc1TxUfU9EjTCU4iOxsMI8XTSsRtxT9BlTtFqkR7wjKuiTsJMFTGdoOL2m+xHrMnojf1M8pKs3d8AM/p6jdT/raMG6y8YL/MLomYjQP6idLu+SsBEOtXKoHAnyLJO0DYVW7d8sSS+ZDRNMOX2jWYTBiN77l0bSW59IyrolC1nAMkPaOoGWBHIj6aMEWWeEilnAptqk3NVb8I7TlmZdljiX2W67vdC5OShTAQe5kT+VkFaoU7ZaBcwJ5wVKzM2EbF+tqMugzbSyhQ6vO537LhnkYYjWTnMJa+9+iid2m23Q5tI9ZPnGzioHUqxkBHatkVy82DJQKGLTTWXUzetO5+YfpaVHDxqnU3SJUDHMfUgyWsUBZMVmdWYBPOZCAb0czIunsxqN0Wa30Z+m2S4nHHU6N4drJxzed8JVLYvEpUEeLQDvhHX2y5q8S4/dBh7ezNcGHt038NKiAaUdTHWuoi9rVHPu3YYcrc34/r4ZfTXjUkT+CTvUt6i+rCX16V0xPal6l/rARYeQN8mDfD/bMrXeXhhpMcyNcAvWvV6yuwOeiYOiv3s9Xo0DRhtAUxzPtPUac5ewLmvP1+HYopmhsX4AH0DXMdFyFU30XUtnqOgglXxiKR62eSbas0O2CpoSPMs+AW0dj4WKD3ZKjTc2DmgdCldvWbp2OM/EL7hgQeXIOipggtY/QR6h8U6n5X2/Och61SI11dx9NNC4U+2VKJfpPEM1oIsJLfLskDUz1FcoQ52iTy8nCBX8v//+j5eobjKegy/gPDeQ6TkaOjzozjOVeCcmEjfpbLvOZyNPJVorFyCUw9jQwRuJWDhePHEoFIY84xMhBbGWYJqkDdSIb1t0DXUJGur6m0HgEOEMJZEdpNa3NI7TwHOnUz9HdWGda3M7JZUC4DDJrVBoLVjESgRVwlWIUK1pQHl6rgCVQ5MZYRG4SAk81QZwOhWhoIFpixoeOki54jHSZAGQ3uSFrLhxWDB6klsHVsvcG0IzpoiuMFEhRrYFb8QMC8OpMULHhcQI4pyGCCDUEUK5xGSGimCC1kFG04sQ/aDWceNA4gyN57BfSTpMIdMUSgSXoKdba0sDOcOVpetIoVC1NGv3ZUbTqezniPiiBVRkoFOMChJEACnULZUeDuB6TbMrnFjhcPz3irDz+fzefvp2W+atcEk+AYOZ3sjFvtHvvrr4+se3LGAOTWrPpwM0MxFWF6g/mLPtwe0ywPLQB1h/gS726k9NAdpNUoSoLNbC4fHbi3cwg+9aHRbUtuYjFG6/65/0zgY9GpdiXLH/DludVoeaKCSmXNWmGpSFo8utwlFzBy83B8a+3LR/KO7LTfty01dPw325aU+hfblpX27606m2Lzf9tcn2vALbvty0Lzf9FSj6J5abytydwzvXziQXPuVZVnKKbOV1VXShClBCeczuNVsuJ9zipZGrFTX/nqOhJOg4YDNuBJ9QKu56vAqqjB+lN29xwbrspHi8HwxpYoLLvEgeNjK/lLAsJI7DEDO3E1tPtV6cD4YsYJOyOpbqiGQMn1PljM9Zl43YiPlKm89S+RoOtS+Z5CrOeUz4YlxKVPKcvFDPct76LGf5hSyrutSipuV2+rMwhf6TYQ8K/EA37V9w8eMaXvT8oUDp2wpNazderVb/A0YmAt4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save 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:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"save-update-webhook",title:"Save or Update Webhook",description:"The save or update Webhook API allow you to save webhook url which is used to trigger events",sidebar_label:"Save or Update Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJztWf9uGzcSfpUJA/SuwVqSUxc4CEVR19HlhMY/EMkwCktwqN3RLmsuuSW5kgVB/92T3KPdkxyGuyut1q7iIEbqa+Q/LIn8hpwZfhySM0vmeGxZ95pd4STR+paNAxahDY3InNCKddkwQbB8hqAN5FnEHUKJheOLPnAp9RwWOgenC9y87M2NhHkiwgSEhdxiRAhnRByjAZyhcnakXr58WX7vjtRIHbbg1auZwDlG3VevRgoA4ACuElRgRazQQNEJkQ7zFJUDlwhbjABzIWU1QauQ/fDhQ/FlWXzQ34h5+Ih1YcSK4UYsqPe7RYZF95vzk8vT3tnwZvjrRa+B0pPfMHT9qIHsvxmxOmwqZHOwy/fvGmMpnjZBZ8enzRmVdiXqQiK3CAZJf+Aq8u4pnFG5piFc+M+S/PWmfcszTV0G/bdnvff3NSm9mHIht4C90+P+uweQWaLV9pAX/zo/69X9BLDa/BhvKV4s0c+Lj0xVAY/LlR32T3uD4fHpRQMVGuTuQViFWo3Ua+JhiWwScU09YaGEfC4Ly2H2NHzGNHwUbwipdvLE6DxOIDJ86sBhmkkKqBRI9xT6f6bQPWRuaiP2z94WrnpSpsFIfUdxyvtjZ5gqEDBZVKfoZ5KtGO/r4ZoXry/ws4lWDbGa0p99EK6IYEf+INRpJvEjR+GGY1zKkmf2I0R7RFirpv56yPa8AtvjIhYaJ6Yi5JXxJ733w/4/+yfHw94Drlwv6pPc1TxUfU9EjTCU4iOxsMI8XTSsRtxT9BlTtFqkR7wjKuiTsJMFTGdoOL2m+xHrMnojf1M8pKs3d8AM/p6jdT/raMG6y8YL/MLomYjQP6idLu+SsBEOtXKoHAnyLJO0DYVW7d8sSS+ZDRNMOX2jWYTBiN77l0bSW59IyrolC1nAMkPaOoGWBHIj6aMEWWeEilnAptqk3NVb8I7TlmZdljiX2W67vdC5OShTAQe5kT+VkFaoU7ZaBcwJ5wVKzM2EbF+tqMugzbSyhQ6vO537LhnkYYjWTnMJa+9+iid2m23Q5tI9ZPnGzioHUqxkBHatkVy82DJQKGLTTWXUzetO5+YfpaVHDxqnU3SJUDHMfUgyWsUBZMVmdWYBPOZCAb0czIunsxqN0Wa30Z+m2S4nHHU6N4drJxzed8JVLYvEpUEeLQDvhHX2y5q8S4/dBh7ezNcGHt038NKiAaUdTHWuoi9rVHPu3YYcrc34/r4ZfTXjUkT+CTvUt6i+rCX16V0xPal6l/rARYeQN8mDfD/bMrXeXhhpMcyNcAvWvV6yuwOeiYOiv3s9Xo0DRhtAUxzPtPUac5ewLmvP1+HYopmhsX4AH0DXMdFyFU30XUtnqOgglXxiKR62eSbas0O2CpoSPMs+AW0dj4WKD3ZKjTc2DmgdCldvWbp2OM/EL7hgQeXIOipggtY/QR6h8U6n5X2/Och61SI11dx9NNC4U+2VKJfpPEM1oIsJLfLskDUz1FcoQ52iTy8nCBX8v//+j5eobjKegy/gPDeQ6TkaOjzozjOVeCcmEjfpbLvOZyNPJVorFyCUw9jQwRuJWDhePHEoFIY84xMhBbGWYJqkDdSIb1t0DXUJGur6m0HgEOEMJZEdpNa3NI7TwHOnUz9HdWGda3M7JZUC4DDJrVBoLVjESgRVwlWIUK1pQHl6rgCVQ5MZYRG4SAk81QZwOhWhoIFpixoeOki54jHSZAGQ3uSFrLhxWDB6klsHVsvcG0IzpoiuMFEhRrYFb8QMC8OpMULHhcQI4pyGCCDUEUK5xGSGimCC1kFG04sQ/aDWceNA4gyN57BfSTpMIdMUSgSXoKdba0sDOcOVpetIoVC1NGv3ZUbTqezniPiiBVRkoFOMChJEACnULZUeDuB6TbMrnFjhcPz3irDz+fzefvp2W+atcEk+AYOZ3sjFvtHvvrr4+se3LGAOTWrPpwM0MxFWF6g/mLPtwe0ywPLQB1h/gS726k9NAdpNUoSoLNbC4fHbi3cwg+9aHRbUtuYjFG6/65/0zgY9GpdiXLH/DludVoeaKCSmXNWmGpSFo8utwlFzBy83B8a+3LR/KO7LTfty01dPw325aU+hfblpX27606m2Lzf9tcn2vALbvty0Lzf9FSj6J5abytydwzvXziQXPuVZVnKKbOV1VXShClBCeczuNVsuJ9zipZGrFTX/nqOhJOg4YDNuBJ9QKu56vAqqjB+lN29xwbrspHi8HwxpYoLLvEgeNjK/lLAsJI7DEDO3E1tPtV6cD4YsYJOyOpbqiGQMn1PljM9Zl43YiPlKm89S+RoOtS+Z5CrOeUz4YlxKVPKcvFDPct76LGf5hSyrutSipuV2+rMwhf6TYQ8K/EA37V9w8eMaXvT8oUDp2wpNazderVb/A0YmAt4=",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"}},j={},v=[{value:"events:",id:"events",level:3},{value:"Request",id:"request",level:2}];function g(e){const n={code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:s}=n;return s||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(n.p,{children:"Save or Update Webhook"})}),"\n",(0,a.jsx)(t(),{method:"post",path:"/webhook"}),"\n",(0,a.jsx)(n.p,{children:"The save or update Webhook API allow you to save webhook url which is used to trigger events"}),"\n",(0,a.jsx)(n.h3,{id:"events",children:"events:"}),"\n",(0,a.jsxs)(n.ol,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"viewed:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When signer viewed document this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"created:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is created this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["When document is created through draft template API this event will trigger.","\n",(0,a.jsx)(n.pre,{children:(0,a.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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.ol,{start:"3",children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"signed:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is signed by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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 {\n "name": "SIGNER_NAME",\n "email": "SIGNER_EMAIL",\n "phone": "SIGNER_PHONE"\n },\n "signedAt": "TIMESTAMP",\n "createdAt": "TIMESTAMP"\n} \n'})}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"completed:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is signed by all signers this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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'})}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"declined:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"When document is declined by signer this event will trigger."}),"\n"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.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'})}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,a.jsx)(n.p,{children:"Body"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,a.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,a.jsx)(n.p,{children:"Provide url to create Webhook"})})}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://your-webhook-url@example.com"}})})]})})}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(p.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook updated successfully!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"401",value:"401",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Webhook url already exists!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Webhook url already exists!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Webhook url already exists!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(h.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(n.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function E(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.37557d76.js b/assets/js/runtime~main.980068b5.js similarity index 98% rename from assets/js/runtime~main.37557d76.js rename to assets/js/runtime~main.980068b5.js index 51cc55607..fd11a664a 100644 --- a/assets/js/runtime~main.37557d76.js +++ b/assets/js/runtime~main.980068b5.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d2fe2a74",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"1e734052",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"b5a7bd46",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"fbcb41b9",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"9d620438",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"fb02f3a5",7964:"4e6965bb",7971:"4b96ecee",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"9bc6455d",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"043a10be",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"0c47a511",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,b,f,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=r,e=[],t.O=(a,c,b,f)=>{if(!c){var d=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,b,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var d={};a=a||[null,c({}),c([]),c(c)];for(var r=2&b&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(f,d),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",339:"4f7a2d40",420:"e2c87691",453:"30a24c52",470:"299c7a47",533:"b2b675dd",762:"d8b805fb",792:"50ea61d6",823:"c7b98810",835:"ab2a161b",841:"c5e4dae0",853:"277a78f5",869:"b18842e4",948:"8717b14a",1001:"8001f939",1332:"f0ff4a36",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1653:"42f80fc5",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2125:"f214d5ff",2207:"78b2b753",2213:"1c822755",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2542:"5ce9853b",2546:"reactPlayerStreamable",2617:"56b5f4f8",2832:"1f73ca32",2865:"3e02da86",3e3:"1ee58ee1",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3156:"11b7b3d8",3205:"a80da1cf",3495:"8a855f99",3514:"73664a40",3554:"5e1bb91e",3608:"9e4087bc",3743:"reactPlayerVimeo",3965:"reactPlayerVidyard",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4641:"ada7accb",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4930:"ae010e44",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6238:"e76c28ee",6344:"984cf7cf",6543:"17e5210b",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7286:"451a5132",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7816:"06577f20",7894:"a88a3db3",7917:"0028a090",7964:"2304e9ae",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8215:"e5a49157",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8784:"83cab870",8866:"eb56c656",8878:"cf03142d",8888:"a9f09360",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"56191834",110:"ab20026d",230:"3cc5e6e9",261:"4b30f79b",273:"e283f01a",339:"d2fe2a74",420:"3b683e17",453:"61f3e45f",470:"2cdb00ea",533:"2d5f5b1d",762:"74ae2291",792:"eda05c15",823:"64f8e5be",835:"ced0e4f6",841:"b9d70538",853:"6965f6a9",869:"52040461",948:"b2da1fd1",1001:"50ee673e",1332:"1e734052",1477:"b31b2642",1512:"9637e502",1520:"523b2d80",1531:"b5a7bd46",1633:"d8366831",1653:"24ec49aa",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"6b36ff91",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"a7b94822",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2542:"28eaefb4",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"eca1c9d2",3e3:"8c874417",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3554:"e5046f78",3608:"0e768bf1",3743:"2ede10ee",3965:"f3db8112",4013:"e5e25f55",4148:"483fa267",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"7f3b7e65",4930:"fbcb41b9",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"bbab5814",5900:"e113e88d",6011:"6de743c9",6033:"9d620438",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"443de2fe",6216:"0d890761",6238:"a8542bf5",6344:"962bbb02",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"6502681d",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7917:"db26237b",7964:"4e6965bb",7971:"4b96ecee",8055:"27482879",8087:"b9e4a7cc",8106:"8bd89dab",8140:"901b2f91",8141:"81bec72f",8163:"4d9dbd85",8215:"c6b04c16",8468:"7cfe3494",8474:"8043eb00",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"cd323a0c",8781:"f4c6405c",8784:"fb16cf6f",8866:"381cdff2",8878:"0d381461",8888:"043a10be",8892:"7315f43d",9003:"1e8e0783",9010:"09a7d359",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"0c47a511",9700:"ad032cc8",9817:"424c677a",9914:"8bf8d5ee"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},f="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=b[e];if(delete b[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273","4f7a2d40":"339",e2c87691:"420","30a24c52":"453","299c7a47":"470",b2b675dd:"533",d8b805fb:"762","50ea61d6":"792",c7b98810:"823",ab2a161b:"835",c5e4dae0:"841","277a78f5":"853",b18842e4:"869","8717b14a":"948","8001f939":"1001",f0ff4a36:"1332",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633","42f80fc5":"1653",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121",f214d5ff:"2125","78b2b753":"2207","1c822755":"2213","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","5ce9853b":"2542",reactPlayerStreamable:"2546","56b5f4f8":"2617","1f73ca32":"2832","3e02da86":"2865","1ee58ee1":"3000","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","11b7b3d8":"3156",a80da1cf:"3205","8a855f99":"3495","73664a40":"3514","5e1bb91e":"3554","9e4087bc":"3608",reactPlayerVimeo:"3743",reactPlayerVidyard:"3965","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478",ada7accb:"4641","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",ae010e44:"4930",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216",e76c28ee:"6238","984cf7cf":"6344","17e5210b":"6543",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","451a5132":"7286","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664","06577f20":"7816",a88a3db3:"7894","0028a090":"7917","2304e9ae":"7964","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163",e5a49157:"8215","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781","83cab870":"8784",eb56c656:"8866",cf03142d:"8878",a9f09360:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>b=e[a]=[c,f]));c.push(b[2]=f);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var f=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+d+")",r.name="ChunkLoadError",r.type=f,r.request=d,b[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,f,d=c[0],r=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in r)t.o(r,b)&&(t.m[b]=r[b]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 8556e0a95..bd7ceb281 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index 2485cc41e..1a566c4e5 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index 9eb5b6bd2..ff42cf783 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 34e3de95c..2a7268ee5 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index f64d3072a..251b43076 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 8af2ebfa1..445530c87 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index 94b6a233c..b1fa2c15a 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index 911757761..e149c8f87 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index 01472a253..080e87ee2 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index e8071bc84..0f98d01df 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index ae2b07c9e..9e2ba27e3 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 9aa027430..d467fdac3 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 19a7719e7..77a250c89 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create Document | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 78e72a0d9..df5881803 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createfolder/index.html b/docs/API-docs/createfolder/index.html index d42c87ce9..6de607be9 100644 --- a/docs/API-docs/createfolder/index.html +++ b/docs/API-docs/createfolder/index.html @@ -5,7 +5,7 @@ Create Folder | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index b69c22544..d8e943493 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create Template | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 802345c8d..2df9991e1 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete Template | OpenSign™ - + diff --git a/docs/API-docs/delete-webhook/index.html b/docs/API-docs/delete-webhook/index.html index e05493327..09e1e6948 100644 --- a/docs/API-docs/delete-webhook/index.html +++ b/docs/API-docs/delete-webhook/index.html @@ -5,7 +5,7 @@ Delete Webhook | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 10974f589..ef0d70bca 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Delete Contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index 35d7e6935..20b78dec3 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/deletefolder/index.html b/docs/API-docs/deletefolder/index.html index c8ccdb7b6..780fd146d 100644 --- a/docs/API-docs/deletefolder/index.html +++ b/docs/API-docs/deletefolder/index.html @@ -5,7 +5,7 @@ Delete Folder | OpenSign™ - + diff --git a/docs/API-docs/draftdocument/index.html b/docs/API-docs/draftdocument/index.html index c58c5ceec..ea7f7429f 100644 --- a/docs/API-docs/draftdocument/index.html +++ b/docs/API-docs/draftdocument/index.html @@ -5,7 +5,7 @@ Draft Document | OpenSign™ - + diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 40b044035..ddf4d5722 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + @@ -14,7 +14,7 @@

The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique objectId (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a url is provided, which offers a user interface for editing the template and facilitating document distribution.

Tip: Upload your PDF document to our Debug UI, where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API.

When document is created this webhook event will trigger

-
 {
     "event": "created",
     "objectId":"DOCUMENT_ID"
     "file": "DOCUMENT_URL",
     "name": "DOCUMENT_NAME",
     "note": "Please review and sign this document",
     "description": "",
     "signers": [
       {
         "name": "SIGNER_NAME",
         "email": "SIGNER_EMAIL",
         "phone": "SIGNER_PHONE",
         "url": "SIGNING_URL"
       }
     ],
     "createdAt": "TIMESTAMP"
 }
+
 {
     "event": "created",
     "type": "DOCUMENT_TYPE",
     "objectId": "DOCUMENT_ID"
     "file": "DOCUMENT_URL",
     "name": "DOCUMENT_NAME",
     "note": "Please review and sign this document",
     "signers": [
       {
         "name": "SIGNER_NAME",
         "email": "SIGNER_EMAIL",
         "phone": "SIGNER_PHONE",
         "url": "SIGNING_URL"
       }
     ],
     "createdAt": "TIMESTAMP"
 }

Supported Widgets:

Below are the common parameters that are required with all widgets:

    diff --git a/docs/API-docs/folderlist/index.html b/docs/API-docs/folderlist/index.html index bd05d53f1..8f6653ed0 100644 --- a/docs/API-docs/folderlist/index.html +++ b/docs/API-docs/folderlist/index.html @@ -5,7 +5,7 @@ Get folder list | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 401038699..f19361bf6 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index d8975f9cc..30d6808d6 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your account details | OpenSign™ - + diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 51427e36b..ba4210b4a 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 405d17ef9..d73bc00c7 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 3ef9fd48b..d59f8cb10 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 32e04b6c1..06e4606bc 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get Document list from status | OpenSign™ - + diff --git a/docs/API-docs/getfolder/index.html b/docs/API-docs/getfolder/index.html index 4663371a1..0796ec9bd 100644 --- a/docs/API-docs/getfolder/index.html +++ b/docs/API-docs/getfolder/index.html @@ -5,7 +5,7 @@ Get Folder | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index ffe4d0e3d..ea7ad6ca5 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get Template list | OpenSign™ - + diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index f561f8085..6500a9532 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index a69126d46..9b735af31 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/resendrequestmail/index.html b/docs/API-docs/resendrequestmail/index.html index f2fd82790..440af4526 100644 --- a/docs/API-docs/resendrequestmail/index.html +++ b/docs/API-docs/resendrequestmail/index.html @@ -5,7 +5,7 @@ Resend request mail | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 968397ed1..de96201c6 100644 --- a/docs/API-docs/save-update-webhook/index.html +++ b/docs/API-docs/save-update-webhook/index.html @@ -5,7 +5,7 @@ Save or Update Webhook | OpenSign™ - + @@ -18,18 +18,18 @@
    • When signer viewed document this event will trigger.
    -
    {
        "event": "viewed",
        "objectId":"DOCUMENT_ID"
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "description": "",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          }
        ],
        "viewedBy": "SIGNER_EMAIL",
        "viewedAt": "TIMESTAMP",
        "createdAt": "TIMESTAMP"
      }
    +
    {
        "event": "viewed",
        "type": "DOCUMENT_TYPE",
        "objectId": "DOCUMENT_ID"
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          }
        ],
        "viewedBy": "SIGNER_EMAIL",
        "viewedAt": "TIMESTAMP",
        "createdAt": "TIMESTAMP"
      }
  • created:
    • When document is created this event will trigger.
    -
    {
        "event": "created",
        "objectId":"DOCUMENT_ID"
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "description": "",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          }
        ],
        "createdAt": "TIMESTAMP"
      }

    +
    {
        "event": "created",
        "type": "DOCUMENT_TYPE",
        "objectId": "DOCUMENT_ID"
        "file": "DOCUMENT_URL",
        "name": "DOCUMENT_NAME",
        "note": "Please review and sign this document",
        "signers": [
          {
            "name": "SIGNER_NAME",
            "email": "SIGNER_EMAIL",
            "phone": "SIGNER_PHONE"
          }
        ],
        "createdAt": "TIMESTAMP"
      }

    • When document is created through draft template API this event will trigger. -
      {
          "event": "created",
          "objectId":"DOCUMENT_ID"
          "file": "DOCUMENT_URL",
          "name": "DOCUMENT_NAME",
          "note": "Please review and sign this document",
          "description": "",
          "signers": [
            {
              "name": "SIGNER_NAME",
              "email": "SIGNER_EMAIL",
              "phone": "SIGNER_PHONE",
              "url": "SIGNING_URL"
            }
          ],
          "createdAt": "TIMESTAMP"
        }

      +
      {
          "event": "created",
          "type": "DOCUMENT_TYPE",
          "objectId": "DOCUMENT_ID"
          "file": "DOCUMENT_URL",
          "name": "DOCUMENT_NAME",
          "note": "Please review and sign this document",
          "signers": [
            {
              "name": "SIGNER_NAME",
              "email": "SIGNER_EMAIL",
              "phone": "SIGNER_PHONE",
              "url": "SIGNING_URL"
            }
          ],
          "createdAt": "TIMESTAMP"
        }

      @@ -37,19 +37,19 @@
      • When document is signed by signer this event will trigger.
      -
      {
          "event": "signed",
          "objectId":"DOCUMENT_ID"
          "file": "DOCUMENT_URL",
          "name": "DOCUMENT_NAME",
          "note": "Please review and sign this document",
          "description": "",
          "signer": 
             {
              "name": "SIGNER_NAME",
              "email": "SIGNER_EMAIL",
              "phone": "SIGNER_PHONE"
            },
                  "signedAt": "TIMESTAMP",
          "createdAt": "TIMESTAMP"
      }
      +
      {
          "event": "signed",
          "type": "DOCUMENT_TYPE",
          "objectId": "DOCUMENT_ID"
          "file": "DOCUMENT_URL",
          "name": "DOCUMENT_NAME",
          "note": "Please review and sign this document",
          "signer": 
             {
              "name": "SIGNER_NAME",
              "email": "SIGNER_EMAIL",
              "phone": "SIGNER_PHONE"
            },
                  "signedAt": "TIMESTAMP",
          "createdAt": "TIMESTAMP"
      }
    1. completed:
      • When document is signed by all signers this event will trigger.
      -
      {
         "event": "completed",
         "objectId":"DOCUMENT_ID"
         "file": "DOCUMENT_URL",
         "name": "DOCUMENT_NAME",
         "note": "Please review and sign this document",
         "description": "",
         "signers": [
           {
             "name": "SIGNER_NAME",
             "email": "SIGNER_EMAIL",
             "phone": "SIGNER_PHONE"
           }
         ],
         "certificate": "CERTIFICATE_URL",
         "completedAt": "TIMESTAMP",
         "createdAt": "TIMESTAMP"
       }

      +
      {
         "event": "completed",
         "type": "DOCUMENT_TYPE",
         "objectId": "DOCUMENT_ID"
         "file": "DOCUMENT_URL",
         "name": "DOCUMENT_NAME",
         "note": "Please review and sign this document",
         "signers": [
           {
             "name": "SIGNER_NAME",
             "email": "SIGNER_EMAIL",
             "phone": "SIGNER_PHONE"
           }
         ],
         "certificate": "CERTIFICATE_URL",
         "completedAt": "TIMESTAMP",
         "createdAt": "TIMESTAMP"
       }

    2. declined:
      • When document is declined by signer this event will trigger.
      -
      {
          "event": "declined",
          "objectId":"DOCUMENT_ID"
          "file": "DOCUMENT_URL",
          "name": "DOCUMENT_NAME",
          "note": "Please review and sign this document",
          "description": "",
          "signers": [
            {
              "name": "SIGNER_NAME",
              "email": "SIGNER_EMAIL",
              "phone": "SIGNER_PHONE"
            }
          ],
          "declinedBy": "SIGNER_EMAIL",
          "declinedAt": "TIMESTAMP",
          "createdAt": "TIMESTAMP"
        }

      +
      {
          "event": "declined",
          "type": "DOCUMENT_TYPE",
          "objectId": "DOCUMENT_ID"
          "file": "DOCUMENT_URL",
          "name": "DOCUMENT_NAME",
          "note": "Please review and sign this document",
          "signers": [
            {
              "name": "SIGNER_NAME",
              "email": "SIGNER_EMAIL",
              "phone": "SIGNER_PHONE"
            }
          ],
          "declinedBy": "SIGNER_EMAIL",
          "declinedAt": "TIMESTAMP",
          "createdAt": "TIMESTAMP"
        }

    Request​

    diff --git a/docs/API-docs/selfsign/index.html b/docs/API-docs/selfsign/index.html index 1911afd78..b7f6df629 100644 --- a/docs/API-docs/selfsign/index.html +++ b/docs/API-docs/selfsign/index.html @@ -5,7 +5,7 @@ Self Sign | OpenSign™ - + diff --git a/docs/API-docs/update-document/index.html b/docs/API-docs/update-document/index.html index 23d3e1cfe..3e4e85b41 100644 --- a/docs/API-docs/update-document/index.html +++ b/docs/API-docs/update-document/index.html @@ -5,7 +5,7 @@ Update Document | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 220b5d4fa..bdb0a8c0d 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/API-docs/updatefolder/index.html b/docs/API-docs/updatefolder/index.html index c3ec138ba..20988a613 100644 --- a/docs/API-docs/updatefolder/index.html +++ b/docs/API-docs/updatefolder/index.html @@ -5,7 +5,7 @@ Update Folder | OpenSign™ - + diff --git a/docs/category/cloud-storage/index.html b/docs/category/cloud-storage/index.html index d9b23b413..7428c374e 100644 --- a/docs/category/cloud-storage/index.html +++ b/docs/category/cloud-storage/index.html @@ -5,7 +5,7 @@ Cloud Storage | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index 7d19914ea..919c3f6e0 100644 --- a/docs/category/create-new-opensign-document/index.html +++ b/docs/category/create-new-opensign-document/index.html @@ -5,7 +5,7 @@ Create New OpenSign Document | OpenSign™ - + diff --git a/docs/category/docker/index.html b/docs/category/docker/index.html index 0a0f090c8..d98052046 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/faqs/index.html b/docs/category/faqs/index.html index 0f2f89580..849503dda 100644 --- a/docs/category/faqs/index.html +++ b/docs/category/faqs/index.html @@ -5,7 +5,7 @@ FAQs | OpenSign™ - + diff --git a/docs/category/guides/index.html b/docs/category/guides/index.html index 895d31a99..70dc17bcf 100644 --- a/docs/category/guides/index.html +++ b/docs/category/guides/index.html @@ -5,7 +5,7 @@ Guides | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 3abc9f81a..fafa8c979 100644 --- a/docs/category/manage-docs-using-opensign-drive/index.html +++ b/docs/category/manage-docs-using-opensign-drive/index.html @@ -5,7 +5,7 @@ Manage Docs using OpenSign™ Drive | OpenSign™ - + diff --git a/docs/category/reports/index.html b/docs/category/reports/index.html index 77ea8de85..48c156ee7 100644 --- a/docs/category/reports/index.html +++ b/docs/category/reports/index.html @@ -5,7 +5,7 @@ Reports | OpenSign™ - + diff --git a/docs/category/settings/index.html b/docs/category/settings/index.html index e89da1eef..6a042fbd4 100644 --- a/docs/category/settings/index.html +++ b/docs/category/settings/index.html @@ -5,7 +5,7 @@ Settings | OpenSign™ - + diff --git a/docs/category/templates/index.html b/docs/category/templates/index.html index 2ef82d1d7..692a7beda 100644 --- a/docs/category/templates/index.html +++ b/docs/category/templates/index.html @@ -5,7 +5,7 @@ Templates | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 53541e57b..765abe707 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index aae073939..f4b85fd85 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ Community at OpenSign™ | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 304449b1b..f45ed23e1 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ Installation instructions | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 5b024b3d8..f0602e17a 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ OpenSign™ Reporting Guidelines | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 84349f9d7..9510a0eeb 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html index 4e26c6133..bfa407f69 100644 --- a/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html +++ b/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements/index.html @@ -5,7 +5,7 @@ Why am I getting 'Ensure this field is accurately filled and meets all requirements'? | OpenSign™ - + diff --git a/docs/help/FAQs/index.html b/docs/help/FAQs/index.html index f6a1c02f6..7a5dfddc9 100644 --- a/docs/help/FAQs/index.html +++ b/docs/help/FAQs/index.html @@ -5,7 +5,7 @@ Why is there no dropdown list when I sign a document myself? | OpenSign™ - + diff --git a/docs/help/New-Document/enforce-email-verification/index.html b/docs/help/New-Document/enforce-email-verification/index.html index b8fce7878..132541072 100644 --- a/docs/help/New-Document/enforce-email-verification/index.html +++ b/docs/help/New-Document/enforce-email-verification/index.html @@ -5,7 +5,7 @@ Enforce email OTP verification | OpenSign™ - + diff --git a/docs/help/New-Document/navigate-between-pages/index.html b/docs/help/New-Document/navigate-between-pages/index.html index 3a51cd97c..7d8e072bd 100644 --- a/docs/help/New-Document/navigate-between-pages/index.html +++ b/docs/help/New-Document/navigate-between-pages/index.html @@ -5,7 +5,7 @@ Navigate between pages of a document | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index b8df4696e..0a6ef9977 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index 41f92dff9..033a954d0 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign your-self | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index be6d48219..482cd58f1 100644 --- a/docs/help/OpenSign™ Drive/create-document/index.html +++ b/docs/help/OpenSign™ Drive/create-document/index.html @@ -5,7 +5,7 @@ Create Docs & Folders | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/list-grid-view/index.html b/docs/help/OpenSign™ Drive/list-grid-view/index.html index 16633f59b..7820f230e 100644 --- a/docs/help/OpenSign™ Drive/list-grid-view/index.html +++ b/docs/help/OpenSign™ Drive/list-grid-view/index.html @@ -5,7 +5,7 @@ Grid vs List view | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/organize-documents/index.html b/docs/help/OpenSign™ Drive/organize-documents/index.html index f5a8c9e87..9ceae4ba5 100644 --- a/docs/help/OpenSign™ Drive/organize-documents/index.html +++ b/docs/help/OpenSign™ Drive/organize-documents/index.html @@ -5,7 +5,7 @@ OpenSign™ Drive Interface Documentation | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/rename-document/index.html b/docs/help/OpenSign™ Drive/rename-document/index.html index 299803aab..ad6d95341 100644 --- a/docs/help/OpenSign™ Drive/rename-document/index.html +++ b/docs/help/OpenSign™ Drive/rename-document/index.html @@ -5,7 +5,7 @@ Rename documents from OpenSign™ Drive | OpenSign™ - + diff --git a/docs/help/Reports/completed/index.html b/docs/help/Reports/completed/index.html index c8c46ab39..58a7f2c64 100644 --- a/docs/help/Reports/completed/index.html +++ b/docs/help/Reports/completed/index.html @@ -5,7 +5,7 @@ Completed | OpenSign™ - + diff --git a/docs/help/Reports/contactbook/index.html b/docs/help/Reports/contactbook/index.html index 71068c06c..7216f2083 100644 --- a/docs/help/Reports/contactbook/index.html +++ b/docs/help/Reports/contactbook/index.html @@ -5,7 +5,7 @@ Contactbook | OpenSign™ - + diff --git a/docs/help/Reports/declined/index.html b/docs/help/Reports/declined/index.html index 591f3adb8..cde94fc32 100644 --- a/docs/help/Reports/declined/index.html +++ b/docs/help/Reports/declined/index.html @@ -5,7 +5,7 @@ Declined | OpenSign™ - + diff --git a/docs/help/Reports/drafts/index.html b/docs/help/Reports/drafts/index.html index 18cdee768..0da60cb79 100644 --- a/docs/help/Reports/drafts/index.html +++ b/docs/help/Reports/drafts/index.html @@ -5,7 +5,7 @@ Drafts | OpenSign™ - + diff --git a/docs/help/Reports/expired/index.html b/docs/help/Reports/expired/index.html index 1d6c9bbd9..eaf4248a7 100644 --- a/docs/help/Reports/expired/index.html +++ b/docs/help/Reports/expired/index.html @@ -5,7 +5,7 @@ Expired | OpenSign™ - + diff --git a/docs/help/Reports/in-progress/index.html b/docs/help/Reports/in-progress/index.html index 8c7956009..fe19160d7 100644 --- a/docs/help/Reports/in-progress/index.html +++ b/docs/help/Reports/in-progress/index.html @@ -5,7 +5,7 @@ In Progress | OpenSign™ - + diff --git a/docs/help/Reports/need-your-sign/index.html b/docs/help/Reports/need-your-sign/index.html index 30fa8e08e..e314191f9 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/disabledocumentid/index.html b/docs/help/Settings/disabledocumentid/index.html index 851deb16f..1c9ab7c64 100644 --- a/docs/help/Settings/disabledocumentid/index.html +++ b/docs/help/Settings/disabledocumentid/index.html @@ -5,7 +5,7 @@ Disable DocumentId | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index ba5fa2e67..1996ee39a 100644 --- a/docs/help/Settings/manage-users/index.html +++ b/docs/help/Settings/manage-users/index.html @@ -5,7 +5,7 @@ Manage users | OpenSign™ - + diff --git a/docs/help/Settings/my-signature/index.html b/docs/help/Settings/my-signature/index.html index bc1f2e945..553e43ca8 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index 85f22ee07..1557f77a7 100644 --- a/docs/help/Templates/create-template/index.html +++ b/docs/help/Templates/create-template/index.html @@ -5,7 +5,7 @@ Create Templates | OpenSign™ - + diff --git a/docs/help/Templates/embed-template/index.html b/docs/help/Templates/embed-template/index.html index b070562f0..dc8ef014f 100644 --- a/docs/help/Templates/embed-template/index.html +++ b/docs/help/Templates/embed-template/index.html @@ -5,7 +5,7 @@ Embedding OpenSign templates | OpenSign™ - + diff --git a/docs/help/Templates/publicTemplate/index.html b/docs/help/Templates/publicTemplate/index.html index 99a06a9e9..a3d762b18 100644 --- a/docs/help/Templates/publicTemplate/index.html +++ b/docs/help/Templates/publicTemplate/index.html @@ -5,7 +5,7 @@ Setting up an OpenSign template for public signing | OpenSign™ - + diff --git a/docs/help/Templates/quick-send/index.html b/docs/help/Templates/quick-send/index.html index a11c3c672..9cfc8c61a 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send the Document for Signature Using Template | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 53479b083..473abfaf4 100644 --- a/docs/help/Templates/use-template/index.html +++ b/docs/help/Templates/use-template/index.html @@ -5,7 +5,7 @@ Use template to create documents | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index bd35ab573..494a8beba 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index 2f6f14e77..e0128d843 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/One-click-Install/DigitalOcean/index.html b/docs/self-host/One-click-Install/DigitalOcean/index.html index 7684ef979..3be7bacb2 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/cloud-storage/s3/index.html b/docs/self-host/cloud-storage/s3/index.html index 17ddae6a4..22e482584 100644 --- a/docs/self-host/cloud-storage/s3/index.html +++ b/docs/self-host/cloud-storage/s3/index.html @@ -5,7 +5,7 @@ AWS S3 | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index 002b53e18..f2e073f62 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™ - + diff --git a/docs/self-host/docker/upgrade-deployment/index.html b/docs/self-host/docker/upgrade-deployment/index.html index c2239abf2..2e4780a0b 100644 --- a/docs/self-host/docker/upgrade-deployment/index.html +++ b/docs/self-host/docker/upgrade-deployment/index.html @@ -5,7 +5,7 @@ OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™ - + diff --git a/docs/self-host/guides/env-variables/index.html b/docs/self-host/guides/env-variables/index.html index 075a7c161..d31cae02c 100644 --- a/docs/self-host/guides/env-variables/index.html +++ b/docs/self-host/guides/env-variables/index.html @@ -5,7 +5,7 @@ ENV variables which are used to setup OpenSign™ with Docker on Localhost | OpenSign™ - + diff --git a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html index 544eff34a..0ed6dd578 100644 --- a/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html +++ b/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate/index.html @@ -5,7 +5,7 @@ How to generate self-signed document signing certificate? | OpenSign™ - + diff --git a/docs/self-host/guides/upgrade-to-v2.1.0/index.html b/docs/self-host/guides/upgrade-to-v2.1.0/index.html index 7d77da157..f307afe85 100644 --- a/docs/self-host/guides/upgrade-to-v2.1.0/index.html +++ b/docs/self-host/guides/upgrade-to-v2.1.0/index.html @@ -5,7 +5,7 @@ How to upgrade self-hosted OpenSign to v2.1.0? | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index e59dd631a..b254c4924 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Self-Hosting OpenSign | OpenSign™ - + diff --git a/index.html b/index.html index f1767ac21..703e8d722 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more. | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 314284c98..db3731e3b 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +