/heartbeat-content | Type: Application | PCID required: Yes
Tools
heartbeat_content_create_channel
Create a new channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelCategoryID | string | Yes | — | Category to place the channel in |
channelType | string | No | — | Channel type (defaults to POSTS) |
description | string | No | — | Channel description |
invitedGroups | string[] | No | — | Group IDs for private channel access |
invitedUsers | string[] | No | — | Email addresses for private channel access |
isPrivate | boolean | Yes | — | Whether the channel is private |
isReadOnly | boolean | No | — | Restrict thread creation to admins/moderators |
name | string | Yes | — | Channel name |
heartbeat_content_create_channel_category
Create a new channel category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Category name |
heartbeat_content_create_comment
Create a comment on a thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
createdAt | string | No | — | ISO 8601 timestamp override |
parentCommentID | string | No | — | Parent comment ID (omit or null for top-level reply, UUID for nested reply up to 2 levels) |
text | string | Yes | — | Comment content (supports rich text) |
threadID | string | Yes | — | Thread to comment on |
userID | string | No | — | Author user ID (admin only, defaults to API key owner) |
heartbeat_content_create_direct_chat
Create or retrieve a direct chat between two users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userID1 | string | Yes | — | First user ID |
userID2 | string | Yes | — | Second user ID |
heartbeat_content_create_event
Create a new event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Event description |
duration | number | Yes | — | Event duration in minutes |
invitedGroups | string[] | No | — | Group IDs to invite (if both empty, all community members are invited) |
invitedUsers | string[] | No | — | Email addresses to invite |
location | string | Yes | — | Where the event is held. Use ‘HEARTBEAT’ for in-app or ‘ZOOM’ for Zoom integration |
name | string | Yes | — | Event name |
startTime | string | Yes | — | Event start time (ISO 8601) |
heartbeat_content_create_lesson
Create a new lesson Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cohortID | string | Yes | — | Cohort ID |
content | string | Yes | — | Lesson content in Markdown |
courseID | string | Yes | — | Course ID |
moduleID | string | Yes | — | Module ID |
title | string | Yes | — | Lesson title |
heartbeat_content_create_thread
Create a new thread in a channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelID | string | Yes | — | Channel to post the thread in |
createdAt | string | No | — | ISO 8601 timestamp override |
embeds | string[] | No | — | HTML embed codes containing iframes |
text | string | Yes | — | Thread content (supports rich text formatting) |
userID | string | No | — | Author user ID (admin only, defaults to API key owner) |
heartbeat_content_create_voice_channel
Create a new voice channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelCategoryID | string | Yes | — | Category for the channel |
description | string | No | — | Voice channel description |
invitedGroups | string[] | No | — | Group IDs for access |
invitedUsers | string[] | No | — | Email addresses for access |
isPrivate | boolean | No | — | Whether the channel is private |
name | string | Yes | — | Voice channel name |
heartbeat_content_create_webhook
Create a new webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | The trigger action for this webhook |
url | string | Yes | — | Webhook delivery URL |
heartbeat_content_delete_channel
Delete a channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelID | string | Yes | — | The channel ID |
heartbeat_content_delete_channel_category
Delete a channel category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelCategoryID | string | Yes | — | The channel category ID |
heartbeat_content_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookID | string | Yes | — | The webhook ID |
heartbeat_content_get_direct_messages
Get the 100 most recent messages from a DM conversation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chatID | string | Yes | — | The chat ID (from createDirectChat) |
heartbeat_content_get_document
Get a document by ID (includes content) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentID | string | Yes | — | The document ID |
heartbeat_content_get_event
Get an event by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventID | string | Yes | — | The event ID |
heartbeat_content_get_event_attendance
Get attendance for the last 10 instances of an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventID | string | Yes | — | The event ID |
heartbeat_content_get_event_instances
Get all instances of a recurring event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventID | string | Yes | — | The event ID |
heartbeat_content_get_lesson
Get a lesson by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lessonID | string | Yes | — | The lesson ID |
heartbeat_content_get_thread
Get a thread by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadID | string | Yes | — | The thread ID |
heartbeat_content_list_channel_categories
List all channel categories in the communityheartbeat_content_list_channels
List all channels in the communityheartbeat_content_list_courses
List all courses in the communityheartbeat_content_list_documents
List all documents (wiki posts) with cursor-based pagination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startingAfter | string | No | — | Cursor for pagination — ID of the last document from the previous page |
limit | integer | No | — | Number of results per page (1-100, default 50) |
heartbeat_content_list_events
List all events in the community Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupID | string | No | — | Filter events to those assigned to this group |
heartbeat_content_list_threads
List the 20 most recent threads in a channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelID | string | Yes | — | The channel ID |
heartbeat_content_list_videos
List all native videos in the communityheartbeat_content_list_webhooks
List all webhooksheartbeat_content_send_chat_channel_message
Send a message to a chat channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelID | string | Yes | — | The chat channel ID |
createdAt | string | No | — | ISO 8601 timestamp override |
from | string | Yes | — | Sender user ID |
text | string | Yes | — | Message content (supports rich text) |
heartbeat_content_send_direct_message
Send a direct message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | Sender user ID (admin only, defaults to API key owner) |
text | string | Yes | — | Message content (supports rich text) |
to | string | Yes | — | Receiver user ID |
heartbeat_content_update_channel
Update a channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelID | string | Yes | — | The channel ID |
description | string | No | — | Updated description |
isReadOnly | boolean | No | — | Restrict thread creation to admins/moderators |
name | string | No | — | Updated channel name |
heartbeat_content_update_channel_category
Update a channel category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channelCategoryID | string | Yes | — | The channel category ID |
name | string | Yes | — | Updated category name |
heartbeat_content_update_lesson
Update a lesson Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lessonID | string | Yes | — | The lesson ID |
content | string | No | — | Lesson content in Markdown |
title | string | No | — | Lesson title |
heartbeat_content_update_voice_channel
Update a voice channel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
voiceChannelID | string | Yes | — | The voice channel ID |
description | string | No | — | Updated description |
name | string | No | — | Updated name |

