# Heartbeat

Plug-and-play online communities. Heartbeat provides tools for creating and managing online communities with features for users, channels, events, messages, and more.

- **Category:** team collaboration
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `HEARTBEAT`
- **Version:** 20260309_00

## Tools

### Get Events

**Slug:** `HEARTBEAT_GET_EVENTS`

Tool to retrieve event information from the community. Use when you need to list events with optional pagination support.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List channels

**Slug:** `HEARTBEAT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results per page. Must be between 1 and 100. If not specified, uses the API's default pagination size. |
| `archived` | string ("all" | "active" | "archived") | No | Filter by archived status. Use 'all' for all channels, 'active' for active channels only, 'archived' for archived channels only. If not specified, defaults to active channels. |
| `channelType` | string ("thread" | "chat" | "voice") | No | Filter by channel type. Use 'thread' for thread channels, 'chat' for chat channels, 'voice' for voice channels. If not specified, returns all types. |
| `startingAfter` | string | No | Cursor token for pagination to fetch the next page of results. Use the cursor from the previous response to get the next page. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Groups

**Slug:** `HEARTBEAT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return (1-100). Used for pagination. |
| `userId` | string | No | Filter groups that a user is a member of. Returns only groups where the specified user is a member. |
| `parentGroupId` | string | No | Filter by parent group. Returns only groups that are children of the specified parent group ID. |
| `startingAfter` | string | No | Cursor for pagination - returns results after this ID. Used to fetch the next page of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `HEARTBEAT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string | No | Filter by user role ID |
| `limit` | integer | No | Number of results to return per page (1-100) |
| `groupId` | string | No | Filter by group membership - returns only users in the specified group |
| `createdAfter` | string | No | Filter users created after this date (ISO 8601 format) |
| `createdBefore` | string | No | Filter users created before this date (ISO 8601 format) |
| `startingAfter` | string | No | Cursor for pagination - return results after this user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reactivate User

**Slug:** `HEARTBEAT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the user to reactivate. The user must have been previously deleted from the community. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Group

**Slug:** `HEARTBEAT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The unique identifier for the group to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve User

**Slug:** `HEARTBEAT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique identifier for the user to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |