Page History

In SimpleOne, REST Bot Engine allows implementing connectors you to in with third-party services (such as messengers, AI systems, and so on) to solve various business tasks depending on the demand. As an example: when an incident is created, the responsible group receives notification to the specified specific messenger with the specified subject specified.

To integrate with the third-party service

, complete the following steps:

1. Do Provide the preparations on the other side (register if needed, get an authorization token, check the API documentation).
2. Create a bot type record.
3. Configure the REST methods used to interact with the third-party service.
4. Configure a bot instance.
5. Configure Set up the routing parameters.
6. Configure Set up the routing rules. 

Create a bot type

A bot type is a connecting element for bot methods and bot instances. When created, you can easily specify which bots can use configured methods, and vice versa.

To create a new bot type, please complete the steps below:

1. Navigate to Bots API → Bot Types.
2. Click New and fill in the form, specify a Name for a bot type.
3. Click Save or Save and Exit to apply the changes.

Configure REST bot methods

In this section, you can configure Configure the REST API methods provided by the third-party system to interact with it. Bot methods are bound with to routing rules and routing parameters. 

To create and configure a new bot method, please complete the following steps below:

1. Navigate to Bots API → Bot Methods.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply the changes.

Bot methods form fields

authorization:Bearer <token>; Content-Type:application/json

{
"channel": "<routing_parameter_0>",
"text": "<content>",
"thread_ts": "<routing_parameter_1>",
}

Configure a bot instance

Create a bot instance to perform integration further (use bot methods, routing rules).

To create a new bot, please complete the steps below:

1. Navigate to Bots API → Bots.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply the changes.

Bot form fields

Configure routing parameters

Routing The routing parameters are used in the bot's routing rules , they allow to be make them more specific. 

The main purpose of this functionality is configuring correlations between to set ip a correlation between a column value upon a when the bot routing rule triggering is triggered, and a column value used in the request body.

To create a routing parameter, please complete the steps below:

1. Navigate to Bots API → Routing Parameters.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply the changes.

Routing Parameter form fields

Configure bot routing rules

The Bot routing rules table contains conditions and rules to trigger; when conditions are met, the trigger performs executes a request to the external service. The request history can be found is in the Related Lists area for every each record.

To create a new bot routing rule, please complete the steps below:

1. Navigate to Bots API → Bot Routing Rules.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply the changes.

Bot request history

In there, the bot requests history to To check out the history of the requests to the third-party services is stored.To check out the history, please complete the following steps below.:

1. Navigate to Bots API → Bot Request History.
2. Click on the record you need to inspect.read.

Bot Request History form fields

Third step

Create a routing parameter. For this, create a record in the Routing Parameter (sys_routing_parameter) table. Fill in the field as described below:

Implementation example

Consider an user case: you need to implement direct notification via messengers.

Input data you have:

First step

Create a notification method. For this, create a record in the Bot Method (sys_bot_method) table as described in this article above. Populate the Body field with the value below:

{
  "channel": "<routing_parameter_0>",
  "text": "<content>",
  "as_user": "true",
  "link_names": "true"
}

In this example, the "channel": "<routing_parameter_0>" bundle specifies that the channel key will substitute the routing_parameter_0 parameter when the request is sent.

Second step

Create a notification rule. For this, create a record in the Bot Routing Rule (sys_bot_routing_rule) table.

In our user case, the trigger will be the new record creation in the Task table.

Routing parameters are defined in the Routing by Column field of the related Routing Rule record and used for sending messages. You can specify more than one parameter in this field numbered starting from 0 (see example below):

{
  "channel": "<routing_parameter_0>",
  "thread": "<routing_parameter_1>",
  "text": "<content>",
  "as_user": "true",
  "link_names": "true"
}

To specify method content more precisely, use fields located in the Content tab of the Bot Routing Rule record.

Avoid using double quotes (" ") in bot routing rule content. Also, it is not allowed to put an odd number of backslashes in a row. If content is generated by a script in the Content Script field, then escape quotes and replace single backslashes (for example, by a slash) before returning values.

The code example below contains regular expression implementing necessary substitutions:

• single backslashes are replaced with slashes
• double quotes are escaped with a backslash

return `Comment: ${current.additional_comments}`
  .replace(/(?<!\\)(?:((\\\\)*)\\)(?![\\/])/g, '\/')
  .replace(/"/g, '\\"')