# Heyy

```json
{
  "name": "Heyy",
  "slug": "heyy",
  "url": "https://composio.dev/toolkits/heyy",
  "markdown_url": "https://composio.dev/toolkits/heyy.md",
  "logo_url": "https://logos.composio.dev/api/heyy",
  "categories": [
    "sales & customer support",
    "collaboration & communication",
    "marketing & social media"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-03-29T06:37:25.481Z"
}
```

![Heyy logo](https://logos.composio.dev/api/heyy)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Heyy MCP or direct API to send messages, manage customer conversations, trigger automations, and monitor communication analytics through natural language.

## Summary

Heyy is a messaging automation platform for WhatsApp, SMS, Messenger, and Instagram. Streamline customer conversations across channels with one tool.

## Categories

- sales & customer support
- collaboration & communication
- marketing & social media

## Toolkit Details

- Tools: 13

## Images

- Logo: https://logos.composio.dev/api/heyy

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Heyy.
  - Setup:
    - Configure Api Key credentials for Heyy.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Send promotional SMS to VIP customers
- Reply to unread Instagram messages
- Broadcast order updates on WhatsApp group

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `HEYY_CREATE_ATTRIBUTE` | Create Contact 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 identifiers. |
| `HEYY_CREATE_CONTACT` | 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 account. |
| `HEYY_CREATE_LABEL` | Create Label | Tool to create a new label for categorizing contacts in Heyy. Use when you need to organize contacts into categories or groups. |
| `HEYY_CREATE_WEBHOOK` | 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. |
| `HEYY_DELETE_ATTRIBUTE` | Delete Attribute | Tool to delete an attribute by its unique identifier. Use when you need to remove an attribute from the system. |
| `HEYY_DELETE_LABEL` | Delete Label | Tool to delete a label by its unique identifier. Use when you need to remove a label from the system. |
| `HEYY_DELETE_WEBHOOK` | Delete Webhook | Tool to delete a webhook by its unique identifier. Use when you need to remove a webhook from Heyy. |
| `HEYY_LIST_ATTRIBUTES` | 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. |
| `HEYY_LIST_AUTOMATIONS` | List Automations | Tool to retrieve automation workflows for a specified channel. Use when you need to get all workflows configured for a channel. |
| `HEYY_LIST_CHANNELS` | 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. |
| `HEYY_LIST_MESSAGE_TEMPLATES` | 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. |
| `HEYY_LIST_API_WEBHOOKS` | List API Webhooks | Tool to retrieve all API webhooks configured for the account. Use when you need to inspect or manage webhook configurations. |
| `HEYY_UPDATE_WEBHOOK` | 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. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Heyy Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Heyy actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Send a WhatsApp message to +1555123456 saying "Your order is confirmed!"'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Send a WhatsApp message to +1555123456 saying "Your order is confirmed!"'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Heyy
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Heyy tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Send a WhatsApp message to +1555123456 saying "Your order is confirmed!"')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'Send a WhatsApp message to +1555123456 saying "Your order is confirmed!"'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Heyy Integration

- Supports both Heyy MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Heyy data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Heyy access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Heyy
- Scoped, least privilege access to Heyy resources
- Full audit trail of agent actions to support review and compliance

## Use Heyy with any AI Agent Framework

Choose a framework you want to connect Heyy with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/heyy/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/heyy/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/heyy/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/heyy/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/heyy/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/heyy/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/heyy/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/heyy/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/heyy/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/heyy/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/heyy/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/heyy/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/heyy/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/heyy/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/heyy/framework/autogen)

## Related Toolkits

- [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable.
- [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management.
- [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place.
- [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action.
- [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication.
- [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack.
- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Aeroleads](https://composio.dev/toolkits/aeroleads) - Aeroleads is a B2B lead generation platform for finding business emails and phone numbers. Grow your sales pipeline faster with powerful prospecting tools.
- [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Autobound](https://composio.dev/toolkits/autobound) - Autobound is an AI-powered sales engagement platform that crafts hyper-personalized outreach and insights. It helps sales teams boost response rates and close more deals through tailored content and recommendations.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.

## Frequently Asked Questions

### Do I need my own developer credentials to use Heyy with Composio?

Yes, Heyy requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)