/heartbeat-community | Type: Application | PCID required: Yes
Tools
heartbeat_community_add_group_members
Add users to a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | The group ID |
emails | string[] | Yes | — | Email addresses of users to add |
shouldRemoveFromSiblingGroups | boolean | No | — | Remove the users from other groups sharing a parent group |
heartbeat_community_create_group
Create a new group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Group description |
isIsolated | boolean | No | — | Whether the group is isolated |
isJoinable | boolean | No | — | Whether users can join the group themselves |
members | string[] | No | — | Email addresses of users to add |
name | string | Yes | — | Group name |
parentGroupID | string | No | — | Parent group ID for nested groups |
heartbeat_community_create_invitation
Create a new invitation link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupIDs | string[] | Yes | — | Groups joining members will be added to |
roleID | string | Yes | — | Role for members who join via this invitation |
heartbeat_community_create_pending_user
Create a pending user who becomes active on first login Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bio | string | No | — | User biography |
email | string | Yes | — | Email address (must be unique) |
groupIDs | string[] | No | — | Groups to add the user to |
name | string | Yes | — | User’s full name |
profilePicture | string | No | — | Profile picture as a data URI |
roleID | string | Yes | — | Role to assign |
heartbeat_community_create_user
Create a new user in the community Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bio | string | No | — | User biography |
createIntroductionThread | boolean | No | — | If true and bio is provided, generates an introduction thread |
email | string | Yes | — | Email address (must be unique to the community) |
groupIDs | string[] | No | — | Groups to add the user to |
instagram | string | No | — | Instagram handle |
linkedin | string | No | — | LinkedIn profile URL |
name | string | Yes | — | User’s full name |
profilePicture | string | No | — | Profile picture as a data URI (JPG/GIF/PNG) |
roleID | string | Yes | — | Role to assign to the user |
status | string | No | — | User status text |
twitter | string | No | — | Twitter handle |
heartbeat_community_delete_group
Delete a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | The group ID |
heartbeat_community_delete_user
Delete a user (preserves their historical content) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email of the user to delete |
heartbeat_community_find_user
Find a user by email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | The email address to search for |
heartbeat_community_get_group
Get a group by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | The group ID |
heartbeat_community_get_notifications
Get the number of pending notifications for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email address of the user |
heartbeat_community_get_user
Get a user by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userID | string | Yes | — | The user’s unique identifier |
heartbeat_community_list_groups
List all groups in the communityheartbeat_community_list_invitations
List all invitations in the communityheartbeat_community_list_roles
List all roles in the communityheartbeat_community_list_users
List all users in the communityheartbeat_community_reactivate_user
Reactivate a deactivated user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email of the user to reactivate |
heartbeat_community_remove_group_members
Remove users from a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | The group ID |
emails | string[] | Yes | — | Email addresses of users to remove |
heartbeat_community_update_group
Update a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | Yes | — | The group ID |
description | string | No | — | Updated description |
isIsolated | boolean | No | — | Whether the group is isolated |
isJoinable | boolean | No | — | Whether users can join themselves |
name | string | No | — | Updated group name |
heartbeat_community_update_invitation
Add users to an existing invitation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
invitationID | string | Yes | — | The invitation ID |
emails | string[] | Yes | — | Email addresses to add to the invitation |
shouldSendEmail | boolean | Yes | — | Whether to send invitation emails |
heartbeat_community_update_user
Update an existing user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bio | string | No | — | Updated biography |
email | string | Yes | — | Email of the user to update (used as identifier) |
instagram | string | No | — | Instagram handle |
linkedin | string | No | — | LinkedIn profile URL |
name | string | No | — | Updated name |
profilePicture | string | No | — | Profile picture as a data URI |
status | string | No | — | Updated status text |
twitter | string | No | — | Twitter handle |

