mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-20 22:52:39 +02:00
53 lines
40 KiB
HTML
53 lines
40 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-API-docs/v1.1/save-update-webhook" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Save or Update Webhook | OpenSign™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" property="og:url" content="https://docs.opensignlabs.com/docs/API-docs/v1.1/save-update-webhook"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Save or Update Webhook | OpenSign™"><meta data-rh="true" name="description" content="The save or update Webhook API allows you to save a webhook URL which is used to trigger events."><meta data-rh="true" property="og:description" content="The save or update Webhook API allows you to save a webhook URL which is used to trigger events."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/save-update-webhook"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/save-update-webhook" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/save-update-webhook" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"v1.1","item":"https://docs.opensignlabs.com/docs/API-docs/v1.1"},{"@type":"ListItem","position":2,"name":"Save or Update Webhook","item":"https://docs.opensignlabs.com/docs/API-docs/v1.1/save-update-webhook"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenSign™ RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenSign™ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.03fa8acf.css">
|
||
<script src="/assets/js/runtime~main.4770fe68.js" defer="defer"></script>
|
||
<script src="/assets/js/main.bbcaf299.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const a=new URLSearchParams(window.location.search).entries();for(var[t,e]of a)if(t.startsWith("docusaurus-data-")){var n=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(n,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_mb4j" style="background-color:#cae4fa;color:#091E42" role="banner"><div class="content_knG7 announcementBarContent_xLdY">Help use spread the word - ⭐ OpenSign on <a target="_blank" rel="noopener" href="https://github.com/opensignlabs/opensign">GitHub</a></div></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">OpenSign™</b></a><a class="navbar__item navbar__link" href="/docs/help/intro">Help</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/API-docs/v1.2">APIs</a><a class="navbar__item navbar__link" href="/docs/contribute/CODE_OF_CONDUCT">Contribute</a><a href="https://www.opensignlabs.com/plans-pricing" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Cloud Pricing<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a class="navbar__item navbar__link" href="/docs/self-host/intro">Self-host</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/API-docs/v1.2"><span title="v1.2" class="categoryLinkLabel_W154">v1.2</span></a><button aria-label="Collapse sidebar category 'v1.2'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/opensign-api-v-1-2"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/get-user"><span title="User" class="categoryLinkLabel_W154">User</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/createcontact"><span title="Contacts" class="categoryLinkLabel_W154">Contacts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/selfsign"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/drafttemplate"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/get-webhook"><span title="Webhook" class="categoryLinkLabel_W154">Webhook</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/createfolder"><span title="Folder" class="categoryLinkLabel_W154">Folder</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--active" href="/docs/API-docs/v1.1"><span title="v1.1" class="categoryLinkLabel_W154">v1.1</span></a><button aria-label="Collapse sidebar category 'v1.1'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.1/opensign-api-v-1-1"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/get-user"><span title="User" class="categoryLinkLabel_W154">User</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/createcontact"><span title="Contacts" class="categoryLinkLabel_W154">Contacts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/selfsign"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/drafttemplate"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/docs/API-docs/v1.1/get-webhook"><span title="Webhook" class="categoryLinkLabel_W154">Webhook</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item get api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.1/get-webhook"><span title="Get Webhook" class="linkLabel_WmDU">Get Webhook</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item post api-method"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/API-docs/v1.1/save-update-webhook"><span title="Save or Update Webhook" class="linkLabel_WmDU">Save or Update Webhook</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item delete api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.1/delete-webhook"><span title="Delete Webhook" class="linkLabel_WmDU">Delete Webhook</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/createfolder"><span title="Folder" class="categoryLinkLabel_W154">Folder</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/API-docs/v1"><span title="v1" class="categoryLinkLabel_W154">v1</span></a><button aria-label="Expand sidebar category 'v1'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col"><div class="docItemContainer_jfFK"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/docs/API-docs/v1.1"><span>v1.1</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Webhook</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Save or Update Webhook</span></li></ul></nav><div class="theme-doc-markdown markdown"><div class="row theme-api-markdown"><div class="col col--7 openapi-left-panel__container"><h1 class="openapi__heading">Save or Update Webhook</h1>
|
||
<pre class="openapi__method-endpoint"><span class="badge badge--success">POST</span> <h2 class="openapi__method-endpoint-path">/webhook</h2></pre><div class="openapi__divider"></div>
|
||
<p>The save or update Webhook API allows you to save a webhook URL which is used to trigger events.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="events">Events:<a href="#events" class="hash-link" aria-label="Direct link to Events:" title="Direct link to Events:" translate="no"></a></h3>
|
||
<p><strong>1. viewed:</strong></p>
|
||
<ul>
|
||
<li class="">When a signer views a document, this event will trigger.</li>
|
||
</ul>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "event": "viewed",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signers": [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "viewedBy": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "viewedAt": "TIMESTAMP",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<p><strong>2. created:</strong></p>
|
||
<ul>
|
||
<li class="">When a document is created, this event will trigger.</li>
|
||
</ul>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "event": "created",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signers": [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class="">When a document is created through the draft template API, this event will trigger.</li>
|
||
</ul>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "event": "created",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signers": [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "url": "SIGNING_URL"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<p><strong>3. signed:</strong></p>
|
||
<ul>
|
||
<li class="">When a document is signed by a signer, this event will trigger.</li>
|
||
</ul>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "event": "signed",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signer": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signedAt": "TIMESTAMP",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<p><strong>4. completed:</strong></p>
|
||
<ul>
|
||
<li class="">When a document is signed by all signers, this event will trigger.</li>
|
||
</ul>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "event": "completed",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signers": [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "certificate": "CERTIFICATE_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "completedAt": "TIMESTAMP",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<p><strong>5. declined:</strong></p>
|
||
<ul>
|
||
<li class="">When a document is declined by a signer, this event will trigger.</li>
|
||
</ul>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "event": "declined",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signers": [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "declinedBy": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "declinedAt": "TIMESTAMP",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq openapi-tabs__heading" id="request">Request<a href="#request" class="hash-link" aria-label="Direct link to request" title="Direct link to request" translate="no"></a></h2>
|
||
<div class="openapi-skeleton sm"></div>
|
||
<div class="openapi-skeleton sm"></div>
|
||
<div class="openapi-tabs__container"><div class="openapi-tabs__response-header-section"><h2 class="anchor anchorTargetStickyNavbar_Vzrq openapi-tabs__heading openapi-tabs__response-header" id="responses">Responses<a href="#responses" class="hash-link" aria-label="Direct link to Responses" title="Direct link to Responses" translate="no"></a></h2><div class="openapi-tabs__response-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__response-list-container tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__response-code-item success active">200</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">400</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">401</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">404</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">405</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Successful operation</p></div></div><div class="openapi-skeleton md"></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Something went wrong, please try again later!</p></div></div><div class="openapi-skeleton md"></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Webhook url already exists!</p></div></div><div class="openapi-skeleton md"></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>User not found!</p></div></div><div class="openapi-skeleton md"></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Invalid API Token!</p></div></div><div class="openapi-skeleton md"></div></div></div></div></div><div class="col col--5 openapi-right-panel__container"><div class="openapi-skeleton lg"></div></div></div></div><div class="row"><div class="col col--7"></div></div></article><div class="row"><div class="col col--7"><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/API-docs/v1.1/get-webhook"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Get Webhook</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/API-docs/v1.1/delete-webhook"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Delete Webhook</div></a></nav></div></div></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/help/intro">Help</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/API-docs/v1.1">APIs</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contribute/intro">Contribute</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/self-host/intro">Self-host</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.com/invite/xe9TDuyAyj" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/opensign%E2%84%A2/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.twitter.com/opensignhq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.facebook.com/profile.php?id=61551030403669" target="_blank" rel="noopener noreferrer" class="footer__link-item">Facebook<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Website<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |