Skip to main content
Server path: /heartbeat-community | Type: Application | PCID required: Yes

Tools

ToolDescription
heartbeat_community_add_group_membersAdd users to a group
heartbeat_community_create_groupCreate a new group
heartbeat_community_create_invitationCreate a new invitation link
heartbeat_community_create_pending_userCreate a pending user who becomes active on first login
heartbeat_community_create_userCreate a new user in the community
heartbeat_community_delete_groupDelete a group
heartbeat_community_delete_userDelete a user (preserves their historical content)
heartbeat_community_find_userFind a user by email address
heartbeat_community_get_groupGet a group by ID
heartbeat_community_get_notificationsGet the number of pending notifications for a user
heartbeat_community_get_userGet a user by ID
heartbeat_community_list_groupsList all groups in the community
heartbeat_community_list_invitationsList all invitations in the community
heartbeat_community_list_rolesList all roles in the community
heartbeat_community_list_usersList all users in the community
heartbeat_community_reactivate_userReactivate a deactivated user
heartbeat_community_remove_group_membersRemove users from a group
heartbeat_community_update_groupUpdate a group
heartbeat_community_update_invitationAdd users to an existing invitation
heartbeat_community_update_userUpdate an existing user

heartbeat_community_add_group_members

Add users to a group Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYesThe group ID
emailsstring[]YesEmail addresses of users to add
shouldRemoveFromSiblingGroupsbooleanNoRemove the users from other groups sharing a parent group

heartbeat_community_create_group

Create a new group Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoGroup description
isIsolatedbooleanNoWhether the group is isolated
isJoinablebooleanNoWhether users can join the group themselves
membersstring[]NoEmail addresses of users to add
namestringYesGroup name
parentGroupIDstringNoParent group ID for nested groups

heartbeat_community_create_invitation

Create a new invitation link Parameters:
ParameterTypeRequiredDefaultDescription
groupIDsstring[]YesGroups joining members will be added to
roleIDstringYesRole for members who join via this invitation

heartbeat_community_create_pending_user

Create a pending user who becomes active on first login Parameters:
ParameterTypeRequiredDefaultDescription
biostringNoUser biography
emailstringYesEmail address (must be unique)
groupIDsstring[]NoGroups to add the user to
namestringYesUser’s full name
profilePicturestringNoProfile picture as a data URI
roleIDstringYesRole to assign

heartbeat_community_create_user

Create a new user in the community Parameters:
ParameterTypeRequiredDefaultDescription
biostringNoUser biography
createIntroductionThreadbooleanNoIf true and bio is provided, generates an introduction thread
emailstringYesEmail address (must be unique to the community)
groupIDsstring[]NoGroups to add the user to
instagramstringNoInstagram handle
linkedinstringNoLinkedIn profile URL
namestringYesUser’s full name
profilePicturestringNoProfile picture as a data URI (JPG/GIF/PNG)
roleIDstringYesRole to assign to the user
statusstringNoUser status text
twitterstringNoTwitter handle

heartbeat_community_delete_group

Delete a group Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYesThe group ID

heartbeat_community_delete_user

Delete a user (preserves their historical content) Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail of the user to delete

heartbeat_community_find_user

Find a user by email address Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email address to search for

heartbeat_community_get_group

Get a group by ID Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYesThe group ID

heartbeat_community_get_notifications

Get the number of pending notifications for a user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail address of the user

heartbeat_community_get_user

Get a user by ID Parameters:
ParameterTypeRequiredDefaultDescription
userIDstringYesThe user’s unique identifier

heartbeat_community_list_groups

List all groups in the community

heartbeat_community_list_invitations

List all invitations in the community

heartbeat_community_list_roles

List all roles in the community

heartbeat_community_list_users

List all users in the community

heartbeat_community_reactivate_user

Reactivate a deactivated user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail of the user to reactivate

heartbeat_community_remove_group_members

Remove users from a group Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYesThe group ID
emailsstring[]YesEmail addresses of users to remove

heartbeat_community_update_group

Update a group Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringYesThe group ID
descriptionstringNoUpdated description
isIsolatedbooleanNoWhether the group is isolated
isJoinablebooleanNoWhether users can join themselves
namestringNoUpdated group name

heartbeat_community_update_invitation

Add users to an existing invitation Parameters:
ParameterTypeRequiredDefaultDescription
invitationIDstringYesThe invitation ID
emailsstring[]YesEmail addresses to add to the invitation
shouldSendEmailbooleanYesWhether to send invitation emails

heartbeat_community_update_user

Update an existing user Parameters:
ParameterTypeRequiredDefaultDescription
biostringNoUpdated biography
emailstringYesEmail of the user to update (used as identifier)
instagramstringNoInstagram handle
linkedinstringNoLinkedIn profile URL
namestringNoUpdated name
profilePicturestringNoProfile picture as a data URI
statusstringNoUpdated status text
twitterstringNoTwitter handle