Table of Contents

Chatforma
- Getting Started with Chatforma
- Connecting Chatforma to Boost.space Integrator
  - Make an API Call
  - Example of Use - List Bots

Active with remarks
This application needs additional settings. Please follow the documentation below to create your own connection.

Chatforma

The Chatforma modules allow you to monitor new inputs, send messages, add, delete the users in a segment, and list bots, forms, users, messages, segments, dialogue users, and user messages in your Chatforma account.

Getting Started with Chatforma

Prerequisites

A Chatforma account

In order to use Chatforma with Boost.space Integrator, it is necessary to have a Chatforma account. If you do not have one, you can create a Chatforma account at chatforma.com.

	Note
	The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!

Connecting Chatforma to Boost.space Integrator

To connect your Chatforma account to Boost.space Integrator you need to obtain the API Key from your Chatforma account and insert it in the Create a connection dialog in the Boost.space Integrator module.

Log in to your Chatforma account.
Click My Profile > Profile > Integration > Create a token.
Enter a name for the token and click Create.
Copy the token to your clipboard.
Go to Boost.space Integrator and open the Chatforma module’s Create a connection dialog.
In the Connection name field, enter a name for the connection.
In the API Key field, enter the token copied in step 4, and click Continue.

The connection has been established.

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Chatforma account.

URL

Enter a path relative tohttps://api.pro.chatforma.com/public. For example: /v1/bots.

	Note
	For the list of available endpoints, refer to the Chatforma API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to 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’ve already done that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use – List Bots

The following API call returns all the bots from your Chatforma account:

URL:

/v1/bots

Method:

GET

Matches of the search can be found in the module’s Output under Bundle > Body.

In our example, 3 bots were returned: