7 available actions
What your AI agent can do in Heartbeat
Plug-and-play online communities. Heartbeat provides tools for creating and managing online communities with features for users, channels, events, messages, and more. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 7 actions.
Common starting points
- Get EventsTool to retrieve event information from the community.
- Retrieve GroupTool to retrieve a single group by its ID.
- Reactivate UserTool to reactivate a previously deleted user by email to allow them to access the community again.
Browse all 7 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 6 actions
- Get EventsTool to retrieve event information from the community.
- List channelsTool to retrieve a paginated list of channels in the community.
- List GroupsTool to retrieve a paginated list of access groups in the community.
- List UsersTool to retrieve a paginated list of users in the Heartbeat community.
- Retrieve GroupTool to retrieve a single group by its ID.
- Retrieve UserTool to retrieve a single user by their ID.
Other actionsSpecialist and administrative actions.View 1 action
- Reactivate UserTool to reactivate a previously deleted user by email to allow them to access the community again.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Heartbeat
How does the agent connect to Heartbeat?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Heartbeat?
The page above lists the 7 actions currently available through the Heartbeat connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Heartbeat included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Heartbeat is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Heartbeat to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.