Built by Metorial, the integration platform for agentic AI.
Create a thread, chat, or voice channel using a category ID from list_channel_categories. Returns the actual HTTP status and provider response.
Read threads from one channel, newest by creation time first. Discover channel IDs with list_community_channels. Responses retain provider permalinks, file URLs, comments, and other metadata.
Update a member profile using their existing email address. This operation does not change the member email, role, or groups. Use manage_group_memberships for group membership changes.
Create a thread using formatted text in a channel from list_community_channels. Returns the actual thread with its provider permalink, file URLs, and metadata.
Create a community member with a full name and a role. Discover role IDs with list_roles and group IDs with list_access_groups. Returns the actual HTTP status and provider response without assuming a profile was returned.
Read one thread, including its comments, reactions, provider permalink, and file URL metadata.
List all community access groups, their parent IDs, archived state, and member information. This endpoint is not paginated.
List community events, optionally filtered by an access group from list_access_groups. Returns provider event IDs, times, invited members and groups, and metadata.
List all members returned by the Heartbeat community API, including role names and group memberships. This endpoint is not paginated.
Deactivate or reactivate a member by email. Deactivation removes community access while preserving threads, comments, and messages.
List community invitation links with their actual codes, roles, and groups. Invitation codes do not identify an API key or the current user.
Discover the channel category IDs and names needed to create community channels.
Create an invitation link for a role and groups, returning the real invitation code and provider metadata. This operation creates a link and does not send an invitation email.
Create a thread comment or a reply to a top-level comment using formatted text. Heartbeat supports two comment levels. Returns the actual comment and provider metadata.
Discover the community role IDs and names needed to provision members or create invitation links.
Add members to, or remove members from, an access group using email addresses. Discover the group ID with list_access_groups. Adding members can remove them from sibling groups.
List all community channels with provider channel types and draft state. This endpoint is not paginated.
Create an access group, optionally assigning member emails and a parent group. Discover existing group IDs with list_access_groups. Returns the actual HTTP status and provider response.
Find community members by email, or retrieve one member by user ID. Returns the complete documented profile and additional provider metadata.
Creates a new group or manages group membership in your Heartbeat community. Can create groups, add users to groups, or remove users from groups. When adding a user, you can optionally remove them from sibling groups (groups sharing a parent), useful for moving users between stages.
Lists members of your Heartbeat community with optional filtering by group, role, or creation date. Returns a paginated list of users.
DEPRECATED — use `provision_member` instead. Creates a new user in your Heartbeat community. Optionally assign groups, set a profile picture, bio, social links, and trigger an introduction thread.
Retrieve one community event by an ID from list_events, preserving provider metadata.
Lists access groups in your Heartbeat community with optional filtering. Can filter by parent group or by user membership.
Deactivates a user in your Heartbeat community. The user will no longer be able to access the community, but their threads, comments, and messages are preserved. Can also reactivate a previously deactivated user.
DEPRECATED — use `edit_member_profile` instead. Updates an existing user's information in your Heartbeat community. Can update name, email, roles, groups, bio, social links, and other profile fields.
Sends an invitation email to a new user to join your Heartbeat community. Optionally specify a pre-approved invitation link to automatically approve the user.
DEPRECATED — use `list_channel_threads` instead. Retrieves the most recently created threads in your Heartbeat community. Can filter by channel. "Recent" refers to creation timestamp — only the most recently created posts are returned.
Lists channels in your Heartbeat community with optional filtering by type or archived status.
Creates a comment on an existing thread. Content can be plain text or rich text (HTML). When rich text is provided, plain text is ignored.
DEPRECATED — use `create_community_channel` instead. Creates a new channel in your Heartbeat community. Channels can be of type thread, chat, or voice.
Creates a new thread in a specific channel. Content can be plain text or rich text (HTML). When rich text is provided, plain text is ignored. Supported HTML tags: p, a, b, h1, h2, h3, ul, li, br.
Finds a user in your Heartbeat community by email address or retrieves a specific user by ID.
Create an event with the start time, duration, location, and optional invited emails or group IDs. Returns the actual HTTP status and provider response.
Sends a direct message to a community member. Useful for automated notifications, bot responses, or personalized outreach.
DEPRECATED — use `schedule_event` instead. Creates a new event in your Heartbeat community. Events can have a location (Zoom requires an integrated Zoom account, Heartbeat creates a custom voice channel). You can invite attendees by email — existing users are invited directly, others receive an email invite.