mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-20 14:42:37 +02:00
deploy: 1a13936681
This commit is contained in:
github-actions[bot]
@@ -5,7 +5,7 @@
|
||||
<meta name="generator" content="Docusaurus v3.0.1">
|
||||
<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 allow you to save webhook url which is used to trigger events"><meta data-rh="true" property="og:description" content="The save or update Webhook API allow you to save 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.ae9c04aa.css">
|
||||
<script src="/assets/js/runtime~main.b32c8971.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.580584a2.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.4ee6bc11.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
@@ -14,35 +14,35 @@
|
||||
<p>The save or update Webhook API allow you to save webhook url which is used to trigger events</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="events">events:<a href="#events" class="hash-link" aria-label="Direct link to events:" title="Direct link to events:"></a></h3>
|
||||
<ol>
|
||||
<li>
|
||||
<p><strong>viewed:</strong></p>
|
||||
<li><strong>viewed:</strong>
|
||||
<ul>
|
||||
<li>When signer viewed 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"> "event": "viewed",</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 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>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>created:</strong></p>
|
||||
<li><strong>created:</strong>
|
||||
<ul>
|
||||
<li>When 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"> "event": "created",</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><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></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>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>signed:</strong></p>
|
||||
<li><strong>signed:</strong>
|
||||
<ul>
|
||||
<li>When document is signed by 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"> "event": "signed",</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"> "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 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>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>completed:</strong></p>
|
||||
<li><strong>completed:</strong>
|
||||
<ul>
|
||||
<li>When 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"> "event": "completed",</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"> "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><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></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>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>declined:</strong></p>
|
||||
<li><strong>declined:</strong>
|
||||
<ul>
|
||||
<li>When document is declined by 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"> "event": "declined",</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><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></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>
|
||||
</li>
|
||||
</ol>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="request">Request<a href="#request" class="hash-link" aria-label="Direct link to Request" title="Direct link to Request"></a></h2>
|
||||
|
||||
Reference in New Issue
Block a user