koziavin
00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
211 lines
21 KiB
HTML
211 lines
21 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<title>Webhook</title>
|
||
<meta name="generator" content="Help+Manual" />
|
||
<meta name="keywords" content="" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="description" content="The Webhook element automatically sends information from a process instance in BRIX to an external system." />
|
||
<meta name="picture" content="" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
|
||
<meta property="og:url" content="https://brix365.com/en/help" />
|
||
<meta property="og:image" content="" />
|
||
<link rel="icon" href="favicon.png" type="image/png" />
|
||
|
||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
|
||
<link rel="stylesheet" href="./jquery-ui.min.css" />
|
||
<link rel="stylesheet" href="default.css" />
|
||
<link rel="stylesheet" href="./search-yandex.css" />
|
||
<link rel="stylesheet" href="./article.css" />
|
||
<link rel="stylesheet" href="./glossary.css" />
|
||
<link rel="stylesheet" href="./theme.css" />
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="helpman_settings.js"></script>
|
||
<script type="text/javascript" src="helpman_topicinit.js"></script>
|
||
|
||
<script type="text/javascript" src="highlight.js"></script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function(){highlight();});
|
||
</script>
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
|
||
|
||
<header class="header elma-365">
|
||
<div class="container">
|
||
<a class="header__logo" href="https://brix365.com/en/help">
|
||
<img src="./logo-en.svg" alt="header logo">
|
||
</a>
|
||
<!-- <div class="hero__search-form" id="search-panel">
|
||
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
|
||
<label class="search-form__label">
|
||
<span id="reset-search" class="search__icon"></span>
|
||
<input class="search-form__input" type="text">
|
||
</label>
|
||
<input class="search-form__submit" type="submit" value="Submit">
|
||
</form>
|
||
</div> -->
|
||
|
||
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
|
||
<div class="hero__search">
|
||
<a href="#" id="search-icon" class="hero__search-icon">
|
||
<img src="search-icon-white.svg" alt="search string">
|
||
</a>
|
||
<a href="#" id="side-menu-icon" class="hero__side-icon">
|
||
<img src="side_menu.svg" alt="side menu">
|
||
</a>
|
||
</div>
|
||
<div class="header__navi">
|
||
|
||
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</header>
|
||
|
||
|
||
|
||
|
||
<main class="main container">
|
||
|
||
<aside class="sidebar" id="sidebar">
|
||
<div class="sidebar__header">
|
||
<a class="header__logo" href="https://brix365.com/en/help">
|
||
<img src="./logo-light-en.svg">
|
||
</a>
|
||
<span class="sidebar__close elma-365-close" id="close"></span>
|
||
</div>
|
||
<div class="sidebar__wrapper" id="side-menu">
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
<article class="article" id="article">
|
||
<div class="article-inner">
|
||
<div class="content">
|
||
<header class="article__header">
|
||
<div class="article__bread" style="display:flex; gap:10px;">
|
||
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
|
||
|
||
<div class="topic__breadcrumbs">
|
||
<p>Business process designer > Graphical elements / Webhook</p>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="topic__title"><h1 class="p_Heading1" style="text-align: center; line-height: 1.20; margin: 19px 0 19px 0;"><span class="f_Heading1" style="font-size: 32px;">Webhook</span></h1>
|
||
</div>
|
||
|
||
</header>
|
||
<section class="article__content">
|
||
<div class="scroll-top-inner">
|
||
<a href="#h1-article" class="scroll-top"></a>
|
||
</div>
|
||
<!-- Placeholder for topic body. -->
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="WH1" width="103" height="83" style="margin:0;width:103px;height:83px;border:none" src="wh1.png"/>The <span style="font-weight: bold;">Webhook</span> element automatically sends information from a process instance in BRIX to an external system.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">As an example, let's consider a company that sells and ships equipment. A sales rep receives an order from a customer and sends it to the warehouse where the order is processed. After invoicing, the order is shipped, and the webhook automatically sends the order's details to the inventory management software.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="clip0020" width="464" height="509" style="margin:0;width:464px;height:509px;border:none" src="clip0020.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">This way the company saves time on entering data and avoids human mistakes, such as specifying a wrong serial number.</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало внимание</span></p>
|
||
<p style="line-height: 1.20; margin: 14px 0 0 0;">Only users included in the <a href="360007146071.html" class="topiclink">Administrators</a> group can manage webhook settings.</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец внимание</span></p>
|
||
<h2 class="p_Heading2" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading2" style="font-size: 24px;">Add a webhook to the process</span></h2>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">On the right pane, go to the <span style="font-weight: bold;">Integrations</span> tab and drag the <span style="font-weight: bold;">Webhook</span> element to the <a href="360012265552.html#create_process" class="topiclink">process diagram</a>. Place the webhook in the part of the diagram where BRIX must send data to the external system.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="WH2" width="789" height="424" style="margin:0;width:789px;height:424px;border:none" src="wh2.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Double-click on the webhook shape in the diagram to open its settings.<span style="font-weight: bold;"> </span></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="wh3" width="654" height="379" style="margin:0;width:654px;height:379px;border:none" src="wh3.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><a id="settings" class="hmanchor"></a></p>
|
||
<h3 class="p_Heading3" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading3" style="font-size: 19px;">General tab</span></h3>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">This tab is for creating the http-request. Fill out the form:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">URL. </span>Specify the request URL for addressing an API method of the external system, for example, <a href="http://example.com/api/create-order/" class="weblink">http://example.com/api/create-order/</a>. In this field, you can use process context variables and the DateTime function. To add a variable, click <span style="font-weight: bold;">{+}</span> on the right-hand side of the field. To use the DateTime function, click the function symbol <span style="font-weight: bold;">{</span><span style="font-style: italic; font-weight: bold;">f </span><span style="font-weight: bold;">}</span>. You can read more about using the DateTime function in the <a href="360007679591.html#date_time" class="topiclink">Item Name</a> article.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Method. </span>Select either GET or POST. If POST is selected, the additional <span style="font-weight: bold;">Request Type</span> field appears.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Request Type. </span>For the POST method the JSON, FORM and TEXT types are available.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Data. </span>Here you can link the process properties and request parameters. Click <span style="font-weight: bold;">+Parameter</span> and select a field in the <span style="font-weight: bold;">Process field</span> column, for example, Serial Number. The <span style="font-weight: bold;">Request parameter</span> field will be filled in automatically.</li></ul>
|
||
<p style="line-height: 1.20;"><img alt="wh4" width="666" height="458" style="margin:0;width:666px;height:458px;border:none" src="wh4.png"/></p>
|
||
<p style="line-height: 1.20;"><span style="font-size: 13px; color: #000000;"> </span></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">If you have selected TEXT in the <span style="font-weight: bold;">Request type</span> field, then in the <span style="font-weight: bold;">Data</span> field you will need to enter a text template that will be passed in the request. To create the template you can use text, process context variables, and the DateTime function. </p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="wh5" width="666" height="416" style="margin:0;width:666px;height:416px;border:none" src="wh5.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">To add a context variable, click the <span style="font-weight: bold;">{+}</span> sign on the right-hand side of the field. To use the DateTime function, click the function symbol <span style="font-weight: bold;">{</span><span style="font-style: italic; font-weight: bold;">f </span><span style="font-weight: bold;">}</span>. You can read more about using the DateTime function in templates in the <a href="360007679591.html#date_time" class="topiclink">Item Name</a> article.</p>
|
||
<h3 class="p_Heading3" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading3" style="font-size: 19px;">Error Handling tab</span></h3>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">In this tab, you can define the behavior of BRIX in case the external system returns an error.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="wh7" width="661" height="346" style="margin:0;width:661px;height:346px;border:none" src="wh7.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">If you want the system to resend the request, check the <span style="font-weight: bold;">Retry</span> box. Then select the number of retries and specify the delay in seconds between them.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="wh6" width="661" height="346" style="margin:0;width:661px;height:346px;border:none" src="wh6.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">If you want the system to send a notification about the error, check the <span style="font-weight: bold;">Notification</span> box. The <span style="font-weight: bold;">Add</span> button will appear. Click on it in order to select the users who must receive the notification.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="wh8" width="489" height="228" style="margin:0;width:489px;height:228px;border:none" src="wh8.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">If you want BRIX to interrupt this operation in case of an error, check the <span style="font-weight: bold;">Interrupt</span> box. Then select the connector that stands for the path that the process must take, for example, <span style="font-weight: bold;">End process</span>.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="wh9" width="659" height="492" style="margin:0;width:659px;height:492px;border:none" src="wh9.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">After having configured all the settings, click <span style="font-weight: bold;">Save</span>.</p>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="business-process-metrics-examples.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">business-process-metrics-examples.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="360013436919.html">
|
||
<span class="bottom-nav__link">360013436919.html</span> <span
|
||
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
|
||
</a>
|
||
|
||
</div>
|
||
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
|
||
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
|
||
|
||
</section>
|
||
</div>
|
||
<aside class="article__sidebar" style="display:none">
|
||
<input type="checkbox" />
|
||
<div class="article__arrow"></div>
|
||
<div class="table-of-contents elma365-right" id="toc2Content">
|
||
<h3 class="h3-toc">In this topic</h3>
|
||
<nav id="toc2"></nav>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</article>
|
||
</main>
|
||
<footer class="footer">
|
||
<div class="footer-container">
|
||
<div class="footer-mobile">
|
||
|
||
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
|
||
|
||
|
||
</div>
|
||
<div class="footer-wrap">
|
||
|
||
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
|
||
|
||
<div class="footer-flex-b">
|
||
<span class="footer-copy">© 2025 BRIX</span>
|
||
<ul class="footer-list">
|
||
|
||
<li class="footer-item">
|
||
<a href="#" class="arrow-top" style="display: block;"></a>
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
<iframe name="hmnavigation" style="display:none!important"></iframe>
|
||
<script src="./jquery-ui.js"></script>
|
||
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
|
||
<script src="./jquery.tocify.min.js"></script>
|
||
<script src="./TypoReporter.min.js"></script>
|
||
<script src="./google-search.js"></script>
|
||
<script src="./main.js"></script>
|
||
</body>
|
||
|
||
</html>
|