AskHandle API Documentation
This is the complete API documentation for connecting to the AskHandle 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 AskHandle: Manage AskHandle chat rooms, messages, leads, widgets, keyword notifications, and webhooks. Keep reading to get started.
Quickstart
Before you run your first AskHandle 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 AskHandle connection — create or choose one in Connections. Note its
connectionId.
Every AskHandle action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/askhandle/actions/{actionSlug}/runYou need a MindCloud API Key and a AskHandle connection. Then call an action such as List Rooms:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/askhandle/actions/list-rooms/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'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.
Authenticate with a MindCloud API Key plus a connectionId for your AskHandle account. See AskHandle API Authentication for the full flow and how to get your connection credentials.
AskHandle actions
All 16 published actions for this AskHandle version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Message
- POSTCreate Room
- POSTCreate Webhook
- DELETEDelete Webhook
- GETList Keyword Notifications
- GETList Leads
- GETList Messages
- GETList Rooms
- GETList Webhooks
- GETRetrieve Message
- GETRetrieve Room
- GETRetrieve Webhook
- PUTUpdate Room
- PUTUpdate Room Field
- PUTUpdate Webhook
- PUTUpdate Webhook Field
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.