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

Tools

ToolDescription
heartbeat_content_create_channelCreate a new channel
heartbeat_content_create_channel_categoryCreate a new channel category
heartbeat_content_create_commentCreate a comment on a thread
heartbeat_content_create_direct_chatCreate or retrieve a direct chat between two users
heartbeat_content_create_eventCreate a new event
heartbeat_content_create_lessonCreate a new lesson
heartbeat_content_create_threadCreate a new thread in a channel
heartbeat_content_create_voice_channelCreate a new voice channel
heartbeat_content_create_webhookCreate a new webhook
heartbeat_content_delete_channelDelete a channel
heartbeat_content_delete_channel_categoryDelete a channel category
heartbeat_content_delete_webhookDelete a webhook
heartbeat_content_get_direct_messagesGet the 100 most recent messages from a DM conversation
heartbeat_content_get_documentGet a document by ID (includes content)
heartbeat_content_get_eventGet an event by ID
heartbeat_content_get_event_attendanceGet attendance for the last 10 instances of an event
heartbeat_content_get_event_instancesGet all instances of a recurring event
heartbeat_content_get_lessonGet a lesson by ID
heartbeat_content_get_threadGet a thread by ID
heartbeat_content_list_channel_categoriesList all channel categories in the community
heartbeat_content_list_channelsList all channels in the community
heartbeat_content_list_coursesList all courses in the community
heartbeat_content_list_documentsList all documents (wiki posts) with cursor-based pagination
heartbeat_content_list_eventsList all events in the community
heartbeat_content_list_threadsList the 20 most recent threads in a channel
heartbeat_content_list_videosList all native videos in the community
heartbeat_content_list_webhooksList all webhooks
heartbeat_content_send_chat_channel_messageSend a message to a chat channel
heartbeat_content_send_direct_messageSend a direct message to a user
heartbeat_content_update_channelUpdate a channel
heartbeat_content_update_channel_categoryUpdate a channel category
heartbeat_content_update_lessonUpdate a lesson
heartbeat_content_update_voice_channelUpdate a voice channel

heartbeat_content_create_channel

Create a new channel Parameters:
ParameterTypeRequiredDefaultDescription
channelCategoryIDstringYesCategory to place the channel in
channelTypestringNoChannel type (defaults to POSTS)
descriptionstringNoChannel description
invitedGroupsstring[]NoGroup IDs for private channel access
invitedUsersstring[]NoEmail addresses for private channel access
isPrivatebooleanYesWhether the channel is private
isReadOnlybooleanNoRestrict thread creation to admins/moderators
namestringYesChannel name

heartbeat_content_create_channel_category

Create a new channel category Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesCategory name

heartbeat_content_create_comment

Create a comment on a thread Parameters:
ParameterTypeRequiredDefaultDescription
createdAtstringNoISO 8601 timestamp override
parentCommentIDstringNoParent comment ID (omit or null for top-level reply, UUID for nested reply up to 2 levels)
textstringYesComment content (supports rich text)
threadIDstringYesThread to comment on
userIDstringNoAuthor user ID (admin only, defaults to API key owner)

heartbeat_content_create_direct_chat

Create or retrieve a direct chat between two users Parameters:
ParameterTypeRequiredDefaultDescription
userID1stringYesFirst user ID
userID2stringYesSecond user ID

heartbeat_content_create_event

Create a new event Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoEvent description
durationnumberYesEvent duration in minutes
invitedGroupsstring[]NoGroup IDs to invite (if both empty, all community members are invited)
invitedUsersstring[]NoEmail addresses to invite
locationstringYesWhere the event is held. Use ‘HEARTBEAT’ for in-app or ‘ZOOM’ for Zoom integration
namestringYesEvent name
startTimestringYesEvent start time (ISO 8601)

heartbeat_content_create_lesson

Create a new lesson Parameters:
ParameterTypeRequiredDefaultDescription
cohortIDstringYesCohort ID
contentstringYesLesson content in Markdown
courseIDstringYesCourse ID
moduleIDstringYesModule ID
titlestringYesLesson title

heartbeat_content_create_thread

Create a new thread in a channel Parameters:
ParameterTypeRequiredDefaultDescription
channelIDstringYesChannel to post the thread in
createdAtstringNoISO 8601 timestamp override
embedsstring[]NoHTML embed codes containing iframes
textstringYesThread content (supports rich text formatting)
userIDstringNoAuthor user ID (admin only, defaults to API key owner)

heartbeat_content_create_voice_channel

Create a new voice channel Parameters:
ParameterTypeRequiredDefaultDescription
channelCategoryIDstringYesCategory for the channel
descriptionstringNoVoice channel description
invitedGroupsstring[]NoGroup IDs for access
invitedUsersstring[]NoEmail addresses for access
isPrivatebooleanNoWhether the channel is private
namestringYesVoice channel name

heartbeat_content_create_webhook

Create a new webhook Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesThe trigger action for this webhook
urlstringYesWebhook delivery URL

heartbeat_content_delete_channel

Delete a channel Parameters:
ParameterTypeRequiredDefaultDescription
channelIDstringYesThe channel ID

heartbeat_content_delete_channel_category

Delete a channel category Parameters:
ParameterTypeRequiredDefaultDescription
channelCategoryIDstringYesThe channel category ID

heartbeat_content_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIDstringYesThe webhook ID

heartbeat_content_get_direct_messages

Get the 100 most recent messages from a DM conversation Parameters:
ParameterTypeRequiredDefaultDescription
chatIDstringYesThe chat ID (from createDirectChat)

heartbeat_content_get_document

Get a document by ID (includes content) Parameters:
ParameterTypeRequiredDefaultDescription
documentIDstringYesThe document ID

heartbeat_content_get_event

Get an event by ID Parameters:
ParameterTypeRequiredDefaultDescription
eventIDstringYesThe event ID

heartbeat_content_get_event_attendance

Get attendance for the last 10 instances of an event Parameters:
ParameterTypeRequiredDefaultDescription
eventIDstringYesThe event ID

heartbeat_content_get_event_instances

Get all instances of a recurring event Parameters:
ParameterTypeRequiredDefaultDescription
eventIDstringYesThe event ID

heartbeat_content_get_lesson

Get a lesson by ID Parameters:
ParameterTypeRequiredDefaultDescription
lessonIDstringYesThe lesson ID

heartbeat_content_get_thread

Get a thread by ID Parameters:
ParameterTypeRequiredDefaultDescription
threadIDstringYesThe thread ID

heartbeat_content_list_channel_categories

List all channel categories in the community

heartbeat_content_list_channels

List all channels in the community

heartbeat_content_list_courses

List all courses in the community

heartbeat_content_list_documents

List all documents (wiki posts) with cursor-based pagination Parameters:
ParameterTypeRequiredDefaultDescription
startingAfterstringNoCursor for pagination — ID of the last document from the previous page
limitintegerNoNumber of results per page (1-100, default 50)

heartbeat_content_list_events

List all events in the community Parameters:
ParameterTypeRequiredDefaultDescription
groupIDstringNoFilter events to those assigned to this group

heartbeat_content_list_threads

List the 20 most recent threads in a channel Parameters:
ParameterTypeRequiredDefaultDescription
channelIDstringYesThe channel ID

heartbeat_content_list_videos

List all native videos in the community

heartbeat_content_list_webhooks

List all webhooks

heartbeat_content_send_chat_channel_message

Send a message to a chat channel Parameters:
ParameterTypeRequiredDefaultDescription
channelIDstringYesThe chat channel ID
createdAtstringNoISO 8601 timestamp override
fromstringYesSender user ID
textstringYesMessage content (supports rich text)

heartbeat_content_send_direct_message

Send a direct message to a user Parameters:
ParameterTypeRequiredDefaultDescription
fromstringNoSender user ID (admin only, defaults to API key owner)
textstringYesMessage content (supports rich text)
tostringYesReceiver user ID

heartbeat_content_update_channel

Update a channel Parameters:
ParameterTypeRequiredDefaultDescription
channelIDstringYesThe channel ID
descriptionstringNoUpdated description
isReadOnlybooleanNoRestrict thread creation to admins/moderators
namestringNoUpdated channel name

heartbeat_content_update_channel_category

Update a channel category Parameters:
ParameterTypeRequiredDefaultDescription
channelCategoryIDstringYesThe channel category ID
namestringYesUpdated category name

heartbeat_content_update_lesson

Update a lesson Parameters:
ParameterTypeRequiredDefaultDescription
lessonIDstringYesThe lesson ID
contentstringNoLesson content in Markdown
titlestringNoLesson title

heartbeat_content_update_voice_channel

Update a voice channel Parameters:
ParameterTypeRequiredDefaultDescription
voiceChannelIDstringYesThe voice channel ID
descriptionstringNoUpdated description
namestringNoUpdated name