Skip to main content
Heartbeat logo
  • Category: team collaboration
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 7
  • Triggers: 0
  • Slug: HEARTBEAT
  • Version: 20261101_00

Tools

Slug: HEARTBEAT_GET_EVENTSRetrieve event information from the Heartbeat community.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEARTBEAT_LIST_CHANNELSTool 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

integer
Number of results per page. Must be between 1 and 100. If not specified, uses the API’s default pagination size.
string ("all" | "active" | "archived")
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.
string ("thread" | "chat" | "voice")
Filter by channel type. Use ‘thread’ for thread channels, ‘chat’ for chat channels, ‘voice’ for voice channels. If not specified, returns all types.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEARTBEAT_LIST_GROUPSTool 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

integer
Number of results to return (1-100). Used for pagination.
string
Filter groups that a user is a member of. Returns only groups where the specified user is a member.
string
Filter by parent group. Returns only groups that are children of the specified parent group ID.
string
Cursor for pagination - returns results after this ID. Used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEARTBEAT_LIST_USERSTool 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

string
Filter by user role ID
integer
Number of results to return per page (1-100)
string
Filter by group membership - returns only users in the specified group
string
Filter users created after this date (ISO 8601 format)
string
Filter users created before this date (ISO 8601 format)
string
Cursor for pagination - return results after this user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEARTBEAT_REACTIVATE_USERTool 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

string
required
Email address of the user to reactivate. The user must have been previously deleted from the community.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEARTBEAT_RETRIEVE_GROUPTool 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

string
required
The unique identifier for the group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEARTBEAT_RETRIEVE_USERTool 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

string
required
The unique identifier for the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not