# Superchat

```json
{
  "name": "Superchat",
  "slug": "superchat",
  "url": "https://composio.dev/toolkits/superchat",
  "markdown_url": "https://composio.dev/toolkits/superchat.md",
  "logo_url": "https://logos.composio.dev/api/superchat",
  "categories": [
    "collaboration & communication"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:27:31.364Z"
}
```

![Superchat logo](https://logos.composio.dev/api/superchat)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Superchat MCP or direct API to send cross-channel replies, fetch customer messages, manage conversations, and automate inbox workflows through natural language.

## Summary

Superchat is a unified messaging platform for businesses, supporting WhatsApp, Instagram, Facebook Messenger, Email, and more. It streamlines communication by centralizing multi-channel conversations in one place.

## Categories

- collaboration & communication

## Toolkit Details

- Tools: 17

## Images

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

## Authentication

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

## Suggested Prompts

- List all WhatsApp conversations from today
- Create a new contact for incoming lead
- Fetch details for contact John Smith
- List available messaging channels in my account

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `SUPERCHAT_CREATE_CONTACT` | Create Contact | Create a new contact in Superchat with phone or email handles. Use this tool to register contact details before sending messages. You must provide at least one handle (phone or email). Optional fields include first name, last name, gender, and custom attributes (if predefined in your account settings). |
| `SUPERCHAT_CREATE_TEMPLATE_FOLDER` | Create Template Folder | Create a new template folder in SuperChat for organizing message templates. Template folders help organize WhatsApp and other messaging templates into logical groups (e.g., Marketing, Sales, Customer Support). Use this action before creating templates when you want to keep them organized. |
| `SUPERCHAT_DELETE_WEBHOOK` | Delete Webhook | Tool to delete a specific webhook by its ID. Use when you need to remove an obsolete or unwanted webhook subscription. First use SUPERCHAT_LIST_WEBHOOKS to retrieve the webhook ID, then use this action to delete it. Example: Delete webhook wh_UPYSN0Etofjl7lhhQ9yhL. |
| `SUPERCHAT_GET_CONTACT` | Get Contact | Retrieve a specific contact's details by ID. Returns the contact's name, handles (phone, email, social), custom attributes, and timestamps. Use this to look up contact information before sending messages or updating contact details. Example: "Get contact details for co_abc123" or "Fetch info for contact co_xyz789". |
| `SUPERCHAT_GET_FILE` | Get File | Retrieve metadata for a specific file by its ID. Returns file details including the file name, MIME type, API resource URL, and a temporary download link with expiration. Use this to get information about uploaded files before downloading or processing them. |
| `SUPERCHAT_GET_USER` | Get User | Retrieve details of a specific user in the Superchat workspace by their user ID. Use this tool when you need to fetch profile information for a known user. Note: You can obtain user IDs by first calling the List Users action. Example user_id format: 'us_abc123xyz' |
| `SUPERCHAT_LIST_CHANNELS` | List Channels | Lists all communication channels in your Superchat workspace. Channels represent different messaging mediums (WhatsApp, email, SMS, Telegram, Instagram, Facebook) through which conversations occur. Results are sorted by creation date (newest first) and can be paginated using 'limit', 'after', or 'before' parameters. |
| `SUPERCHAT_LIST_CONTACTS` | List Contacts | List all contacts in the Superchat workspace with cursor-based pagination. Use this tool to browse contacts, find contact IDs, or export contact data. Results are sorted by creation date (newest first). |
| `SUPERCHAT_LIST_CONVERSATIONS` | List Conversations | Retrieves a paginated list of all conversations in your Superchat account. Each conversation includes channel info, status (open/snoozed/done), assigned users, contacts, labels, and inbox details. Use this to browse conversations, find specific ones by status or channel, or get conversation IDs for further operations. Supports cursor-based pagination to handle large result sets. |
| `SUPERCHAT_LIST_CUSTOM_ATTRIBUTES` | List Custom Attributes | List all custom attributes defined for contacts in your Superchat account. Custom attributes are user-defined fields that extend contact data beyond standard fields like name and email. Use this action to discover available custom attributes before reading or updating contact information. Supports cursor-based pagination for accounts with many custom attributes. Common use cases: - Discover available custom fields before updating contacts - Retrieve custom attribute types (string, number, date, select, etc.) - Get custom attribute IDs for use in other API calls |
| `SUPERCHAT_LIST_INBOXES` | List Inboxes | Tool to list all inboxes. Use when you need to retrieve inbox IDs and metadata before sending or organizing messages. |
| `SUPERCHAT_LIST_LABELS` | List Labels | List all labels in the Superchat workspace. Labels are used to categorize and organize conversations. Use this tool to retrieve available labels and their IDs, which can then be used to assign labels to conversations via the update conversation endpoint. Supports cursor-based pagination for workspaces with many labels. |
| `SUPERCHAT_LIST_TEMPLATES` | List Templates | Tool to list all message templates. Use when you need to fetch available message templates. |
| `SUPERCHAT_LIST_USERS` | List Users | Retrieve all users in the workspace. Returns user profiles including names, emails, roles, and contact info. Supports pagination for large workspaces. Use cases: - Get a directory of all workspace members - Find user IDs for other API operations - Audit user roles and permissions |
| `SUPERCHAT_LIST_WEBHOOKS` | List Webhooks | Tool to list all webhooks configured in the workspace. Use this tool to: - Retrieve all active and paused webhooks - Get webhook IDs for use with update or delete operations - Check webhook status and event subscriptions Supports pagination via 'limit', 'after', and 'before' parameters. |
| `SUPERCHAT_UPDATE_CONTACT` | Update Contact | Update information for a specific contact in Superchat. Use this tool to modify a contact's name, gender, handles (phone/email), or custom attributes. Requires the contact_id (prefixed with 'ct_') which can be obtained from List Contacts or Create Contact. Examples: - Update first name: {"contact_id": "ct_abc123", "first_name": "Jane"} - Update gender: {"contact_id": "ct_abc123", "gender": "female"} - Update phone handle: {"contact_id": "ct_abc123", "handles": [{"type": "phone", "value": "+1234567890"}]} |
| `SUPERCHAT_UPDATE_WEBHOOK` | Update Webhook | Update an existing webhook's target URL and/or event subscriptions. Use this tool to: - Change the webhook delivery URL - Add or remove event subscriptions - Update event types the webhook listens to Note: Webhook status (ACTIVE/PAUSED) is automatically managed by the API and cannot be manually changed. Webhooks become PAUSED after 7 days of consistent delivery failures. |

## 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 Superchat Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Superchat actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'List all WhatsApp channels connected to my account'
  }]
)
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: 'List all WhatsApp channels connected to my account'
  }],
});
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 and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

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

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```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' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

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

Use the MCP server with your AI agent
```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 Superchat tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('List all conversations from WhatsApp channel')
        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, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: 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: 'List all conversations from WhatsApp channel' }],
  stopWhen: stepCountIs(5)
});

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

## Why Use Composio?

### 1. AI Native Superchat Integration

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

### 2. Managed Auth

- Built-in API key handling with secure vault storage
- Central place to manage, scope, and revoke Superchat 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 Superchat
- Scoped, least privilege access to Superchat resources
- Full audit trail of agent actions to support review and compliance

## Use Superchat with any AI Agent Framework

Choose a framework you want to connect Superchat with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/superchat/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/superchat/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/superchat/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/superchat/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/superchat/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/superchat/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/superchat/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/superchat/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/superchat/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/superchat/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/superchat/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/superchat/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/superchat/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/superchat/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/superchat/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.
- [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.
- [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.
- [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.
- [Chatwork](https://composio.dev/toolkits/chatwork) - Chatwork is a team communication platform with group chats, file sharing, and task management. It helps businesses boost collaboration and streamline productivity.
- [Clickmeeting](https://composio.dev/toolkits/clickmeeting) - ClickMeeting is a cloud-based platform for running online meetings and webinars. It helps businesses and individuals host, manage, and engage virtual audiences with ease.
- [Confluence](https://composio.dev/toolkits/confluence) - Confluence is Atlassian's team collaboration and knowledge management platform. It helps your team organize, share, and update documents and project content in one secure workspace.
- [Dailybot](https://composio.dev/toolkits/dailybot) - DailyBot streamlines team collaboration with chat-based standups, reminders, and polls. It keeps work flowing smoothly in your favorite messaging platforms.
- [Dialmycalls](https://composio.dev/toolkits/dialmycalls) - Dialmycalls is a mass notification service for sending voice and text messages to contacts. It helps teams and organizations quickly broadcast urgent alerts and updates.
- [Dialpad](https://composio.dev/toolkits/dialpad) - Dialpad is a cloud-based business phone and contact center system for teams. It unifies voice, video, messaging, and meetings across your devices.
- [Discord](https://composio.dev/toolkits/discord) - Discord is a real-time messaging and VoIP platform for communities and teams. It lets users chat, share media, and collaborate across public and private channels.
- [Discordbot](https://composio.dev/toolkits/discordbot) - Discordbot is an automation tool for Discord servers that handles moderation, messaging, and user engagement. It helps communities run smoothly by automating routine and complex tasks.
- [Echtpost](https://composio.dev/toolkits/echtpost) - Echtpost is a secure digital communication platform for encrypted document and message exchange. It ensures confidential data stays private and protected during transmission.
- [Egnyte](https://composio.dev/toolkits/egnyte) - Egnyte is a cloud-based platform for secure file sharing, storage, and governance. It helps teams collaborate efficiently while maintaining data compliance and security.
- [Google Meet](https://composio.dev/toolkits/googlemeet) - Google Meet is a secure video conferencing platform for virtual meetings, chat, and screen sharing. It helps teams connect, collaborate, and communicate seamlessly from anywhere.

## Frequently Asked Questions

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

Yes, Superchat 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)