# Heyy — how to use (mcp.ai)

Connect your Heyy account and use 13 tools for communication straight from your AI agent. Connect with your own API key. Connect with your customers on Whatsapp, SMS, Messenger and Instagram using automation.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_heyy?ms=1787291280000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `heyy_create_attribute`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/heyy`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/heyy/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/heyy/create/attribute` — Tool to create a new custom attribute for contacts in Heyy. Use when you need to add custom fields to track additional information about contacts, such as customer segments, preferences, or custom ide
  - body: { name: string, externalId: string, description?: string, isVisibleQuickEdit?: boolean, isVisibleContactCreate?: boolean, isVisibleContactsTable?: boolean }
- `POST https://api.mcp.ai/api/heyy/create/contact` — Tool to create a new contact in Heyy with optional details including first name, last name, email, phone number, labels, and custom attributes. Use when you need to add a new contact to your Heyy acco
  - body: { email?: string, labels?: object[], lastName?: string, firstName?: string, attributes?: object[], phoneNumber?: string }
- `POST https://api.mcp.ai/api/heyy/create/label` — Tool to create a new label for categorizing contacts in Heyy. Use when you need to organize contacts into categories or groups.
  - body: { name: string }
- `POST https://api.mcp.ai/api/heyy/create/webhook` — Tool to create a new webhook for receiving event notifications across multiple channels. Use when you need to set up real-time event notifications for messages.
  - body: { url: string, type: string, tenant_id: string, channel_id?: string }
- `POST https://api.mcp.ai/api/heyy/delete/attribute` — Tool to delete an attribute by its unique identifier. Use when you need to remove an attribute from the system.
  - body: { attribute_id: string }
- `POST https://api.mcp.ai/api/heyy/delete/label` — Tool to delete a label by its unique identifier. Use when you need to remove a label from the system.
  - body: { label_id: string }
- `POST https://api.mcp.ai/api/heyy/delete/webhook` — Tool to delete a webhook by its unique identifier. Use when you need to remove a webhook from Heyy.
  - body: { webhook_id: string }
- `POST https://api.mcp.ai/api/heyy/list/attributes` — Tool to retrieve all attributes available in the Heyy system. Use when you need to get a list of all attributes with their properties and visibility settings.
- `POST https://api.mcp.ai/api/heyy/list/automations` — Tool to retrieve automation workflows for a specified channel. Use when you need to get all workflows configured for a channel.
  - body: { channel_id: string }
- `POST https://api.mcp.ai/api/heyy/list/channels` — Tool to retrieve all available channels from the Heyy system. Use when you need to get a complete list of channels with their details including name, type, status, and timestamps.
- `POST https://api.mcp.ai/api/heyy/list/message/templates` — Tool to retrieve all message templates available in the Heyy system. Use when you need to view all existing templates for messaging.
- `POST https://api.mcp.ai/api/heyy/list/webhooks` — Tool to retrieve all API webhooks configured for the account. Use when you need to inspect or manage webhook configurations.
- `POST https://api.mcp.ai/api/heyy/update/webhook` — Tool to update a webhook's URL and active status. Use when you need to modify an existing webhook's endpoint or enable/disable it.
  - body: { url?: string, is_active?: boolean, webhook_id: string }

## Example prompts
- "What can I do in Heyy?"
- "Show me a summary of my Heyy account"

## More
- Page: https://mcp.ai/heyy
- Agent spec (llms.txt): https://mcp.ai/heyy/llms.txt
- Postman collection: https://mcp.ai/heyy/postman.json