| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
The ChatBot modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) allow you to watch, create, update, list, retrieve, and delete the usersCan use the system on a limited basis based on the rights assigned by the admin. and stories in your ChatBot account.
Prerequisites
-
A ChatBot account
In order to use ChatBot with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., it is necessary to have a ChatBot account. If you do not have one, you can create a ChatBot account at accounts.chatbot.com/signup?.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
To connect your ChatBot account to Boost.space Integrator you need to obtain the Developer Access TokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. from your ChatBot account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Log in to your ChatBot account and open your Dashboard.
-
Click Your Profile Icon > Settings > API Keys.
-
Copy the Developer Access Token to your clipboard.
-
Go to Boost.space Integrator and open the ChatBot module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the Access Token field, enter the token copied in step 3, and click Continue.
The connection has been established.
Searches for users or lists them all.
|
Connection |
|
|
After |
Select the UserCan use the system on a limited basis based on the rights assigned by the admin. ID to search the user listed after the specified user. |
|
Field |
Select the option to sort the users:
|
|
Order |
Select the order in which you want to sort the users:
|
|
Match |
Select the option to match the users:
|
|
Type |
Select the user type:
|
|
Limit |
Set the maximum number of users Boost.space Integrator should return during one scenario execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Returns details of a user-specified by ID.
|
Connection |
|
|
User ID |
Select the User ID whose details you want to retrieve. |
Creates a new user.
|
Connection |
|
|
Do you want to provide user ID manually or to be generated automatically? |
Select the option to create the user:
|
|
Custom User ID |
Enter a unique User ID for the new user. |
|
|
Enter the user’s email address. |
|
Segments |
Enter the segment details for the user. |
|
Username |
Enter a username. |
|
Name |
Enter the user’s name. |
|
URL |
Enter the URL address to the user’s website. |
|
Avatar |
Enter the URL address of the user’s profile picture. |
|
Langauge |
Enter the language applicable to the user. |
|
Timezone |
Select the user’s timezone. |
|
Gender |
Select the user’s gender:
|
|
IP Address |
Enter the user’s IP address. |
|
City |
Enter the user’s city name. |
|
Region |
Enter the user’s region or province or state name. |
|
Country |
Enter the user’s country name. |
|
Referrer |
Enter the reference details of the user. |
|
Custom FieldsA feature in Boost.space that allows you to define and manage data within each module according to your specific needs. |
Add the custom fieldA feature in Boost.space that allows you to define and manage data within each module according to your specific needs. key and its values. |
Updates a user-specified by ID.
|
Connection |
|
|
User ID |
Select the User ID whose details you want to update. |
|
Username |
Enter a username for the user. |
|
|
Enter the user’s email address. |
|
Name |
Enter the user’s name. |
|
URL |
Enter the URL address of the user’s website. |
|
Avatar |
Enter the URL address of the user’s profile picture. |
|
Language |
Enter the language applicable to the user. |
|
Timezone |
Select the user’s timezone. |
|
Gender |
Select the user’s gender:
|
|
IP Address |
Enter the user’s IP address. |
|
City |
Enter the user’s city name. |
|
Region |
Enter the user’s region or province or state name. |
|
Country |
Enter the user’s country name. |
|
Referrer |
Enter the reference details of the user. |
|
Custom Fields |
Add the custom field key and its values. |
Changes ban statusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. of a user-specified by ID.
|
Connection |
|
|
User ID |
Select the User ID you want to ban or unban. |
|
OperationAn operation is a task performed by module. Type |
Select the action to perform:
|
Returns a list of all stories.
|
Connection |
|
|
Limit |
Set the maximum number of stories Boost.space Integrator should return during one scenario execution cycle. |
Returns details of a story specified by ID.
|
Connection |
|
|
Story ID |
Select the Story ID whose details you want to retrieve. |
Creates a new story.
|
Connection |
|
|
Name |
Enter the name of the story |
|
Description |
Enter the details of the story. |
Updates a story specified by ID.
|
Connection |
Establish a connection to your ChatBot account. |
|
Story ID |
Select the Story ID whose details you want to retrieve. |
|
Name |
Enter the name of the story |
|
Description |
Enter the details of the story. |
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a user sends a specified message into a chat.
|
Note |
|---|---|
|
You do not have to add the webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. in the ChatBot as it is automatically done for you once you add and save an instant triggerEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... module to your scenario. |
|
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. Name |
Enter a name for the webhook. |
|
Connection |
|
|
Webhook Name |
Enter the webhook name that appears in the ChatBot UI. |
Performs an arbitrary authorized API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry.PUTto update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
|
Query String |
Enter the request query string. |
|||
|
Body |
Enter the body content for your API call. |
The following API call returns all the stories from your ChatBot account:
URL:
/stories
Method:
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body.
In our example, 3 stories were returned:
