Social Intents API Documentation
This is the complete API documentation for connecting to the Social Intents 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 Social Intents: Manage live chat widgets, conversations, offline messages, and leads. Keep reading to get started.
Quickstart
Before you run your first Social Intents request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Social Intents connection — create or choose one in Connections. Note its
connectionId.
Every Social Intents action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/socialIntents/latest/actions/{actionSlug}You need a MindCloud API Key and a Social Intents connection. Then call an action such as Get Chat By ID:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/socialIntents/latest/actions/get-chat-by-id" \
--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 Social Intents account that should run the action. MindCloud stores and refreshes the Social Intents 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.
Social Intents actions
All 31 published actions for this Social Intents version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Chat Completed Webhook
- POSTCreate Lead Captured Webhook
- POSTCreate Offline Message Webhook
- DELETEDelete Webhook
- DELETEDelete Widget Webhook
- GETGet Chat By ID
- GETGet Offline Message By ID
- GETList Chats
- GETList Chats By Date Range
- GETList Chats By Email
- GETList Chats By Timezone
- GETList Chats By Visitor
- GETList Chats By Widget
- GETList Contacts / Leads
- GETList Contacts By Date Range
- GETList Contacts By Timezone
- GETList Contacts By Widget
- GETList Missed Chats
- GETList Missed Chats By Date Range
- GETList Missed Chats By Email
- GETList Missed Chats By Timezone
- GETList Missed Chats By Visitor
- GETList Missed Chats By Widget
- GETList Offline Messages
- GETList Offline Messages By Date Range
- GETList Offline Messages By Email
- GETList Offline Messages By Timezone
- GETList Offline Messages By Visitor
- GETList Offline Messages By Widget
- GETList Widgets
- GETPing API
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.