# Heartbeat

```json
{
  "name": "Heartbeat",
  "slug": "heartbeat",
  "url": "https://composio.dev/toolkits/heartbeat",
  "markdown_url": "https://composio.dev/toolkits/heartbeat.md",
  "logo_url": "https://logos.composio.dev/api/heartbeat",
  "categories": [
    "collaboration & communication",
    "productivity & project management"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-03-29T06:37:10.262Z"
}
```

![Heartbeat logo](https://logos.composio.dev/api/heartbeat)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Heartbeat MCP or direct API to manage users, organize events, post messages, and moderate channels through natural language.

## Summary

Heartbeat is a plug-and-play platform for building and managing online communities. It helps you organize users, channels, events, and discussions in one place.

## Categories

- collaboration & communication
- productivity & project management

## Toolkit Details

- Tools: 7

## Images

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

## Authentication

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

## Suggested Prompts

- List all upcoming Heartbeat community events
- Post a message in #general channel
- Get member count for each Heartbeat channel

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `HEARTBEAT_GET_EVENTS` | Get Events | Tool to retrieve event information from the community. Use when you need to list events with optional pagination support. |
| `HEARTBEAT_LIST_CHANNELS` | List channels | Tool to retrieve a paginated list of channels in the community. Use when you need to list, browse, or search for channels in the Heartbeat community. Supports filtering by archived status, channel type, and pagination. |
| `HEARTBEAT_LIST_GROUPS` | List Groups | Tool to retrieve a paginated list of access groups in the community. Use when you need to browse groups with optional filters for parent groups or user membership. Supports cursor-based pagination. |
| `HEARTBEAT_LIST_USERS` | List Users | Tool to retrieve a paginated list of users in the Heartbeat community. Use when you need to get user information with optional filtering by creation date, group membership, or role. |
| `HEARTBEAT_REACTIVATE_USER` | Reactivate User | Tool to reactivate a previously deleted user by email to allow them to access the community again. Use when you need to restore access for a user who was previously removed. |
| `HEARTBEAT_RETRIEVE_GROUP` | Retrieve Group | Tool to retrieve a single group by its ID. Use when you need to get detailed information about a specific group in the Heartbeat community. |
| `HEARTBEAT_RETRIEVE_USER` | Retrieve User | Tool to retrieve a single user by their ID. Use when you need to get detailed information about a specific user in the Heartbeat community. |

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

Get tools from Tool Router session and execute Heartbeat actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'List all upcoming Heartbeat community events.'
  }]
)
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 upcoming Heartbeat community events.'
  }],
});
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 Heartbeat
```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 Heartbeat tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Post a welcome message to the #general channel in Heartbeat.')
        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: 'Post a welcome message to the #general channel in Heartbeat.'
  }],
  maxSteps: 5,
});

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

## Why Use Composio?

### 1. AI Native Heartbeat Integration

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

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Heartbeat 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 Heartbeat
- Scoped, least privilege access to Heartbeat resources
- Full audit trail of agent actions to support review and compliance

## Use Heartbeat with any AI Agent Framework

Choose a framework you want to connect Heartbeat with:

- [ChatGPT](https://composio.dev/toolkits/heartbeat/framework/chatgpt)
- [Antigravity](https://composio.dev/toolkits/heartbeat/framework/antigravity)
- [OpenAI Agents SDK](https://composio.dev/toolkits/heartbeat/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/heartbeat/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/heartbeat/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/heartbeat/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/heartbeat/framework/codex)
- [Cursor](https://composio.dev/toolkits/heartbeat/framework/cursor)
- [VS Code](https://composio.dev/toolkits/heartbeat/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/heartbeat/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/heartbeat/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/heartbeat/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/heartbeat/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/heartbeat/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/heartbeat/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/heartbeat/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/heartbeat/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/heartbeat/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/heartbeat/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/heartbeat/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.
- [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly.
- [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place.
- [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.
- [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations.
- [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.
- [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals.
- [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem.
- [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity.
- [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.
- [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently.
- [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place.
- [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.
- [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time.
- [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.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [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.
- [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place.
- [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place.

## Frequently Asked Questions

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

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