Heyy API Documentation

This is the complete API documentation for connecting to the Heyy 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 Heyy: Heyy lets teams manage WhatsApp conversations, contacts, broadcasts, automations, labels, files, webhooks, and workspace configuration through the Heyy API. Keep reading to get started.

Quickstart

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

Every Heyy action uses the same URL pattern:

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

You need a MindCloud API Key and a Heyy connection. Then call an action such as Get Broadcast by ID:

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

Heyy actions

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

• PUTAdd Contact Attribute
• PUTAdd Recipients To Broadcast
• POSTCreate API Webhook
• POSTCreate Attribute
• POSTCreate Broadcast
• POSTCreate Contact
• POSTCreate Label
• DELETEDelete API Webhook
• DELETEDelete Attribute
• DELETEDelete Broadcast
• DELETEDelete Contact
• DELETEDelete Label
• GETGet Broadcast by ID
• GETGet Business
• GETGet Channel by ID
• GETGet Chat by ID
• GETGet Contact by ID
• GETList API Webhooks
• GETList Attributes
• GETList Automations
• GETList Broadcast Recipients
• GETList Broadcasts
• GETList Channels
• GETList Chats
• GETList Contacts
• GETList Labels
• GETList Message Templates
• PUTRemove Contact Attribute
• PUTRemove Recipients From Broadcast
• POSTSend WhatsApp Message
• PUTStart Broadcast
• POSTTrigger Automation
• PUTUpdate API Webhook
• PUTUpdate Broadcast
• PUTUpdate Chat
• PUTUpdate Contact
• POSTUpload File

Related apps

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

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS