Chatforma API Documentation

This is the complete API documentation for connecting to the Chatforma API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Chatforma: Create chatbots, manage forms, and message bot users. Keep reading to get started.

Quickstart

Before you run your first Chatforma request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Chatforma connection — create or choose one in Connections. Note its connectionId.

Every Chatforma action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/chatforma/latest/actions/{actionSlug}

You need a MindCloud API Key and a Chatforma connection. Then call an action such as Get Current Account:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chatforma/latest/actions/get-current-account" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Chatforma account that should run the action. MindCloud stores and refreshes the Chatforma credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Chatforma actions

All 25 published actions for this Chatforma version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd User To Segment
• POSTCreate Bot Variable
• POSTCreate Dispatch To Segment
• POSTCreate Dispatch To User
• POSTCreate User Variable
• DELETEDelete Bot Variable
• GETGet Current Account
• GETGet Notification Sample
• GETGet User Variable
• GETList Bot Messages
• GETList Bot Users
• GETList Bot Variables
• GETList Bots
• GETList Forms
• GETList Notifications
• GETList Open Dialog Users
• GETList Segment Users
• GETList Segments
• GETList User Messages
• DELETERemove User From Segment
• POSTSend Existing Message To Segment
• POSTSend Existing Message To User
• POSTSend Message To Dialog User
• POSTSubscribe To Notifications
• DELETEUnsubscribe From Notifications

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS