WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-21 07:02:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

deploy: eaed35cefd

Browse Source
This commit is contained in:
github-actions[bot]
2025-02-18 13:34:23 +00:00
parent 6386092d16
commit 3611a7933f
107 changed files with 108 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API-docs/save-update-webhook/index.html
+7 -7
View File
@@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.7.0">
<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/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/save-update-webhook"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/save-update-webhook" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/save-update-webhook" hreflang="x-default"><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.6bed5790.css">
<script src="/assets/js/runtime~main.77ec3449.js" defer="defer"></script>
<script src="/assets/js/runtime~main.7a1d249c.js" defer="defer"></script>
<script src="/assets/js/main.707be612.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -17,31 +17,31 @@
<ul>
<li>When a signer views a document, this event will trigger.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;viewed&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;viewedBy&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;viewedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;viewed&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;viewedBy&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;viewedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p><strong>2. created:</strong></p>
<ul>
<li>When a document is created, this event will trigger.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;created&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;created&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<ul>
<li>When a document is created through the draft template API, this event will trigger.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;created&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;url&quot;: &quot;SIGNING_URL&quot;</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"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;created&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;url&quot;: &quot;SIGNING_URL&quot;</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"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p><strong>3. signed:</strong></p>
<ul>
<li>When a document is signed by a signer, this event will trigger.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;signed&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signer&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;signedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;signed&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signer&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;signedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p><strong>4. completed:</strong></p>
<ul>
<li>When a document is signed by all signers, this event will trigger.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;completed&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;certificate&quot;: &quot;CERTIFICATE_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;completedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;completed&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;certificate&quot;: &quot;CERTIFICATE_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;completedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p><strong>5. declined:</strong></p>
<ul>
<li>When a document is declined by a signer, this event will trigger.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;declined&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;declinedBy&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;declinedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><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"> &quot;event&quot;: &quot;declined&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;type&quot;: &quot;DOCUMENT_TYPE&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;objectId&quot;: &quot;DOCUMENT_ID&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;file&quot;: &quot;DOCUMENT_URL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;DOCUMENT_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;note&quot;: &quot;Please review and sign this document&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signers&quot;: [</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"> &quot;name&quot;: &quot;SIGNER_NAME&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;email&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;phone&quot;: &quot;SIGNER_PHONE&quot;</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"> &quot;declinedBy&quot;: &quot;SIGNER_EMAIL&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;declinedAt&quot;: &quot;TIMESTAMP&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;createdAt&quot;: &quot;TIMESTAMP&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<h2 class="anchor anchorWithStickyNavbar_LWe7 openapi-tabs__heading" id="request">Request<a href="#request" class="hash-link" aria-label="Direct link to Request" title="Direct link to Request">​</a></h2>
<div class="openapi-skeleton sm"></div>
<div class="openapi-skeleton sm"></div>