REST Bot Engine

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

To integrate with the third-party service, complete the following steps:

1. Configure the third-party service (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. Set up the routing parameters.
6. Set up the routing rules. 

Create a bot type

A bot type is a connecting element for the 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, complete the steps below:

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

Configure REST bot methods

Configure the REST API methods provided by the third-party system to interact with it. The bot methods are bound to the routing rules and routing parameters. 

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

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 continue the integration process (use bot methods, routing rules).

To create a new bot, 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

The routing parameters are used in the bot's routing rules to make them more specific. 

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

To create a routing parameter, 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 executes a request to the external service. The request history is in the Related Lists area for each record.

To create a new bot routing rule, 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

To check out the history of the requests to the third-party services, complete the following steps:

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

Bot Request History form fields