Initial commit. Start adding 'Using webhooks in DocSpace' article

This commit is contained in:
Svetlana Maleeva 2023-10-18 18:33:41 +03:00
parent 6d57d60454
commit d88d9c269c
14 changed files with 125 additions and 0 deletions

View File

@ -431,6 +431,7 @@
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-two-factor-authentication.aspx")%>">Using two-factor authentication in DocSpace</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-sso-settings.aspx")%>">Enabling Single Sign-on in DocSpace</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-active-connections.aspx")%>">Managing Active sessions in DocSpace</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-webhooks.aspx")%>">Using webhooks in DocSpace</a></li>
</ul>
</div>
</li>

View File

@ -61,6 +61,7 @@
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-two-factor-authentication.aspx")%>">Using two-factor authentication in DocSpace</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-sso-settings.aspx")%>">Enabling Single Sign-on in DocSpace</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-active-connections.aspx")%>">Managing Active sessions in DocSpace</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-webhooks.aspx")%>">Using webhooks in DocSpace</a></li>
</ul>
</li>

View File

@ -0,0 +1,105 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Using webhooks in DocSpace";
MetaKeyWords = "webhooks";
MetaDescription = "Use webhooks to perform custom actions on the side of any application or website you are using based on various events in ONLYOFFICE DocSpace.";
var guides = new GuidesModel();
(Page as BasePage).Guides = guides;
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Using webhooks in DocSpace</h1>
<%--<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/two-step-verification/two-step-verification.ascx" /></li>
</ul>
</div>--%>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Webhooks allow notifying a pre-configured recipient about events on the portal using the http/https callbacks. A user can configure webhooks so that events on the portal trigger actions on external services. This approach can be useful for synchronizing and tracking certain events.</p>
<p>Use webhooks to perform custom actions on the side of any application or website you are using based on various events in ONLYOFFICE DocSpace.</p>
<p>You can create and manage all your webhooks, configure them, and browse history of every webhook to audit their performance.</p>
</div>
</div>
</div>
<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>
<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>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>
</ul>
</li>
<li>Click the <b>Create</b> button.</li>
</ol>
<p>The created webhook will be assigned to all DocSpace events.</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")%>" />
<img alt="Using webhooks in DocSpace" id="img1_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide178/create_webhook.png")%>" />
<div target="img1_eventcom_guides" class="screenphoto magnifier"></div>
</div>
</div>
<h2 id="step2"><span class="style_step"></span>Managing webhooks</h2>
<div class="block_of_step">
<div class="screen_text">
<p>You can disable or re-enable the created webhook using the switcher next to it. Use the <img alt="Options icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsoptionsicon.png")%>" /> icon on the right to change the webhook settings specified during its creation, view the webhook history, or delete the webhook.</p>
</div>
<div class="screen_block">
<img alt="Using webhooks in DocSpace" target="img2_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide178/manage_webhook.png")%>" />
<img alt="Using webhooks in DocSpace" id="img2_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide178/manage_webhook.png")%>" />
<div target="img2_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<div class="screen_text">
<p>When viewing history, you can filter webhooks by delivery date or status (Not sent, 2XX, 3XX, 4XX, 5XX). Click the <img alt="Filter icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsfilter.png")%>" /> filter button, choose the necessary parameters and click <b>Apply</b>.</p>
<p>You can select one or more webhooks in the list and use the <img alt="Retry icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsretry.png")%>" /> <b>Retry</b> option which appears on the top to redeliver the selected webhooks. Or click the <img alt="Options icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsoptionsicon.png")%>" /> icon next to the certain webhook and select the <img alt="Retry icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsretry.png")%>" /> <b>Retry</b> option in the context menu.</p>
</div>
<div class="screen_block">
<img alt="Using webhooks in DocSpace" target="img3_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide178/webhook_history.png")%>" />
<img alt="Using webhooks in DocSpace" id="img3_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide178/webhook_history.png")%>" />
<div target="img3_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<div class="screen_text">
<p>Click the <img alt="Options icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsoptionsicon.png")%>" /> icon next to the certain webhook and select the <img alt="Retry icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsinfoicon.png")%>" /> <b>Webhook details</b> option in the context menu.</p>
</div>
<div class="screen_block">
<img alt="Using webhooks in DocSpace" target="img4_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide178/webhook_details.png")%>" />
<img alt="Using webhooks in DocSpace" id="img4_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide178/webhook_details.png")%>" />
<div target="img4_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<div class="screen_text">
<p>The following details are available:</p>
<ul>
<li><b>Status</b> a response status.</li>
<li><b>Event ID</b> an ID of the event.</li>
<li><b>Event time</b> a date when the event occurred.</li>
<li><b>Delivery time</b> a date when the webhook was sent to the endpoint.</li>
</ul>
<p>In the <b>Request/Response</b> sections, you can also view the POST request header, POST request body, POST response header, and POST response body. Use the <img alt="Copy icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dscopylink.png")%>" /> icon to copy the request or response header/body to the clipboard.</p>
<p>Use the <img alt="Retry icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsretry2.png")%>" /> icon next to the <b>Webhook details</b> caption to redeliver the webhook.</p>
</div>
</div>
</div>

View File

@ -0,0 +1,18 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/Administration/AdministrationArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<body class="administration_guides_docspace">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Guides/General/DocSpaceWebhooks/DocSpaceWebhooks.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="administrationdocspacepage general">
<%--<div id="SeeAlsoBlockLinks">
<div class="caption gs one">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/070_configuration.ascx" />
</div>
</div>--%>
</asp:Content>

Binary file not shown.

After

Width:  |  Height:  |  Size: 394 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 443 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB