Edit DocSpaceWebhooks.ascx, update screen

This commit is contained in:
Svetlana Maleeva 2023-10-20 14:37:07 +03:00
parent 5e7dd9f149
commit c493593c95
3 changed files with 6 additions and 5 deletions

View File

@ -38,23 +38,24 @@
<h2 id="step1"><span class="style_step"></span>Creating a new webhook</h2>
<div class="block_of_step">
<div class="screen_text">
<p>To create a new webhook,</p>
<p>First of all, you need to set up an endpoint for webhooks within your external service. This endpoint will be used to listen for DocSpace webhooks and receive event notifications.</p>
<p>Once you create and configure your endpoint, you can create webhooks in DocSpace. To create a new webhook,</p>
<ol>
<li>Use the <img alt="Options icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsoptionsicon.png")%>" /> menu in the lower left corner and select the <b>Settings</b> option.</li>
<li>In the DocSpace settings, open the <b>Developer tools</b> section on the left.</li>
<li>In the DocSpace settings, open the <b>Developer Tools</b> section on the left.</li>
<li>Go to the <b>Webhooks</b> section.</li>
<li>Click the <b>Create webhook</b> button.</li>
<li>Set the necessary parameters:
<ul>
<li><b>Webhook name</b> an identifier name for convenient work with the webhook on the portal.</li>
<li><b>Payload URL</b> an address of the endpoint where the webhook should be sent.</li>
<li><b>Secret key</b> Set a webhook secret which allows you to verify requests sent to the payload URL. Enter your own key or click Generate. Please note: you cannot retrieve your secret key again once it has been saved. If you've lost or forgotten this secret key, you can reset it, but all integrations using this secret will need to be updated.</li>
<li><b>SSL verification</b> By default, this option is enabled to verify SSL certificates when delivering payloads. Its not recommended to disable this parameter.</li>
<li><b>Secret key</b> set a webhook secret which allows you to verify requests sent to the payload URL. Enter your own key or click <b>Generate</b>. Please note: you cannot retrieve your secret key again once it has been saved. If you've lost or forgotten this secret key, you can reset it, but all integrations using this secret will need to be updated.</li>
<li><b>SSL verification</b> by default, this option is enabled to verify SSL certificates when delivering payloads. Its not recommended to disable this parameter.</li>
</ul>
</li>
<li>Click the <b>Create</b> button.</li>
</ol>
<p>The created webhook will be assigned to all DocSpace events.</p>
<p>The created webhook will be assigned to all DocSpace events. You will receive automatic notifications on DocSpace events within your external service.</p>
</div>
<div class="screen_block">
<img alt="Using webhooks in DocSpace" target="img1_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide178/create_webhook.png")%>" />

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB