Kommunicate API Documentation

This is the complete API documentation for connecting to the Kommunicate 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 Kommunicate: Manage support conversations, users, messages, and agent routing. Keep reading to get started.

Quickstart

Before you run your first Kommunicate 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 Kommunicate connection — create or choose one in Connections. Note its connectionId.

Every Kommunicate action uses the same URL pattern:

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

You need a MindCloud API Key and a Kommunicate connection. Then call an action such as Get User Detail:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/kommunicate/latest/actions/get-user-detail" \
  --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 Kommunicate account that should run the action. MindCloud stores and refreshes the Kommunicate 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.

Kommunicate actions

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

• PUTChange Conversation Assignee
• PUTChange Conversation Status
• POSTCreate Conversation
• POSTCreate Conversation With Assignee
• GETGet User Detail
• POSTSend Attachments
• POSTSend Auto Suggestion Message
• POSTSend Card Carousel Message
• POSTSend Custom Input Field Message
• POSTSend Form Template Message
• POSTSend Generic Card Message
• POSTSend HTML Content Message
• POSTSend Image Template Message
• POSTSend Link Button Message
• POSTSend List Template Message
• POSTSend Message
• POSTSend Mixed Buttons Message
• POSTSend Submit Button Message
• POSTSend Suggested Replies Message
• POSTSend Video Message
• PUTUpdate User Details

Related apps

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

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear