NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Heartbeat connects to a Nagent workspace with an API key. Once it is connected, agents can call 7 Heartbeat actions, such as "Get Events", "List channels" and "List Groups". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Heartbeat, with input parameters and output schema.
HEARTBEAT_GET_EVENTSTool to retrieve event information from the community. Use when you need to list events with optional pagination support.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEARTBEAT_LIST_CHANNELSTool 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.
Input parameters
Number of results per page. Must be between 1 and 100. If not specified, uses the API's default pagination size.
Filter 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.
Filter by channel type. Use 'thread' for thread channels, 'chat' for chat channels, 'voice' for voice channels. If not specified, returns all types.
Cursor 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEARTBEAT_LIST_GROUPSTool 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.
Input parameters
Number of results to return (1-100). Used for pagination.
Filter groups that a user is a member of. Returns only groups where the specified user is a member.
Filter by parent group. Returns only groups that are children of the specified parent group ID.
Cursor for pagination - returns results after this ID. Used to fetch the next page of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEARTBEAT_LIST_USERSTool 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.
Input parameters
Filter by user role ID
Number of results to return per page (1-100)
Filter by group membership - returns only users in the specified group
Filter users created after this date (ISO 8601 format)
Filter users created before this date (ISO 8601 format)
Cursor for pagination - return results after this user ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEARTBEAT_REACTIVATE_USERTool 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.
Input parameters
Email address of the user to reactivate. The user must have been previously deleted from the community.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEARTBEAT_RETRIEVE_GROUPTool to retrieve a single group by its ID. Use when you need to get detailed information about a specific group in the Heartbeat community.
Input parameters
The unique identifier for the group to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEARTBEAT_RETRIEVE_USERTool to retrieve a single user by their ID. Use when you need to get detailed information about a specific user in the Heartbeat community.
Input parameters
The unique identifier for the user to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 7 Heartbeat actions on Nagent, including "Get Events", "List channels" and "List Groups". Get Events: Retrieve event information from the community. Each action is listed on this page with its input parameters and its output.
Heartbeat connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.