Heartbeat
heartbeatPlug-and-play online communities. Heartbeat provides tools for creating and managing online communities with features for users, channels, events, messages, and more.
Acciones disponibles (7)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Get EventsHEARTBEAT_GET_EVENTSAcciónTool to retrieve event information from the community. Use when you need to list events with optional pagination support.
HEARTBEAT_GET_EVENTSAcciónTool to retrieve event information from the community. Use when you need to list events with optional pagination support.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List channelsHEARTBEAT_LIST_CHANNELSAcciónTool 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.
HEARTBEAT_LIST_CHANNELSAcciónTool 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.
Parámetros de entrada
limitintegerNumber of results per page. Must be between 1 and 100. If not specified, uses the API's default pagination size.
archivedstringenumFilter 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.
allactivearchivedchannelTypestringenumFilter by channel type. Use 'thread' for thread channels, 'chat' for chat channels, 'voice' for voice channels. If not specified, returns all types.
threadchatvoicestartingAfterstringCursor 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.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List GroupsHEARTBEAT_LIST_GROUPSAcciónTool 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.
HEARTBEAT_LIST_GROUPSAcciónTool 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.
Parámetros de entrada
limitintegerNumber of results to return (1-100). Used for pagination.
userIdstringFilter groups that a user is a member of. Returns only groups where the specified user is a member.
parentGroupIdstringFilter by parent group. Returns only groups that are children of the specified parent group ID.
startingAfterstringCursor for pagination - returns results after this ID. Used to fetch the next page of results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List UsersHEARTBEAT_LIST_USERSAcciónTool 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.
HEARTBEAT_LIST_USERSAcciónTool 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.
Parámetros de entrada
rolestringFilter by user role ID
limitintegerNumber of results to return per page (1-100)
groupIdstringFilter by group membership - returns only users in the specified group
createdAfterstringFilter users created after this date (ISO 8601 format)
createdBeforestringFilter users created before this date (ISO 8601 format)
startingAfterstringCursor for pagination - return results after this user ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reactivate UserHEARTBEAT_REACTIVATE_USERAcciónTool 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.
HEARTBEAT_REACTIVATE_USERAcciónTool 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.
Parámetros de entrada
emailstringObligatorioEmail address of the user to reactivate. The user must have been previously deleted from the community.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve GroupHEARTBEAT_RETRIEVE_GROUPAcciónTool to retrieve a single group by its ID. Use when you need to get detailed information about a specific group in the Heartbeat community.
HEARTBEAT_RETRIEVE_GROUPAcciónTool to retrieve a single group by its ID. Use when you need to get detailed information about a specific group in the Heartbeat community.
Parámetros de entrada
group_idstringObligatorioThe unique identifier for the group to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve UserHEARTBEAT_RETRIEVE_USERAcciónTool to retrieve a single user by their ID. Use when you need to get detailed information about a specific user in the Heartbeat community.
HEARTBEAT_RETRIEVE_USERAcciónTool to retrieve a single user by their ID. Use when you need to get detailed information about a specific user in the Heartbeat community.
Parámetros de entrada
user_idstringObligatorioThe unique identifier for the user to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not