Heartbeat MCP integration for AI agents.
Connect AI agents to Heartbeat through 7 structured actions, including find users by email, get group, and get user. Review authentication, inputs, workflows…
- ACTION CONTRACTS
- 7
- AUTHENTICATION
- API key
- SOURCE STATUS
- Provider-backed
CATALOG SOURCE REVIEWED AUGUST 23, 2026 / ACTION NAMES AND SCHEMAS DERIVED FROM WORKING MACHINES PROVIDER SOURCE
CAPABILITY PROFILE
What the Heartbeat integration exposes
The Heartbeat Agent App exposes 7 provider-backed actions for communication and social work. Its current contract lets an authorized agent find heartbeat community users whose email matches exactly, retrieve one heartbeat access group by group id, and retrieve one heartbeat community user by user id. These operations are called through Working Machines as typed capabilities rather than through browser navigation or copied UI steps.
A connection uses API key. Before execution, the agent can inspect the selected action, its required fields, declared scopes, and expected output contract. Provider credentials remain inside the Working Machines runtime; the calling agent receives the capability and its structured result, not the underlying secret.
For reliable operation, start with the narrowest action that satisfies the task, resolve stable provider identifiers before changing state, and validate the returned object or status after execution. Availability still depends on the connected Heartbeat account, granted provider permissions, workspace policy, region, plan, and upstream API behavior.
VERIFIED ACTION SAMPLE
Real Heartbeat capabilities.
Showing 7 of 7 actions. Risk labels are conservative signals based on operation names, not substitutes for provider documentation or runtime policy.
find_users_by_emailREADFind Heartbeat community users whose email matches exactly.
INPUTS: email
get_groupREADRetrieve one Heartbeat access group by group ID.
INPUTS: groupId
get_userREADRetrieve one Heartbeat community user by user ID.
INPUTS: userId
list_channelsREADList all channels in the connected Heartbeat community.
list_eventsREADList Heartbeat community events, optionally filtered by access group.
INPUTS: groupId
list_groupsREADList all access groups in the connected Heartbeat community.
list_usersREADList all users in the connected Heartbeat community.
INPUT CONTRACTS
Know what the action needs before it runs.
find_users_by_email
emailREQUIRED- The exact user email address to find.
get_group
groupIdREQUIRED- The unique Heartbeat group ID.
get_user
userIdREQUIRED- The unique Heartbeat user ID.
list_events
groupIdOPTIONAL- Return only events assigned to this Heartbeat group ID.
PROVIDER-SPECIFIC WORKFLOWS
Jobs this Agent App can support
Inspect Find Users By Email
Find Heartbeat community users whose email matches exactly. Use this as a bounded discovery step, retain the returned identifier, and avoid expanding the read beyond the task's stated scope.
find_users_by_emailVerify with Get Group
Retrieve one Heartbeat access group by group ID. Compare the returned provider state with the intended outcome and preserve stable IDs or canonical links in the run record.
get_groupSAFETY BOUNDARY
Operate Heartbeat with explicit limits
- Authorize Heartbeat with API key and grant only the provider access required by the selected actions.
- The current action names appear read-oriented, but returned Heartbeat data may still be sensitive and should be minimized before it enters model context.
- Do not infer permission from catalog visibility. Workspace policy, connection identity, and upstream authorization still govern execution.
- No provider scope string is declared on the sampled actions. Verify the connected account's actual permissions in Heartbeat rather than assuming unrestricted access.
- After a call, inspect the structured result and execution record before reporting that the Heartbeat task completed successfully.
CONNECTION MODEL
API key
Heartbeat API key sent as a Bearer token. Create it from Settings > System > API Keys in your Heartbeat community: https://help.heartbeat.chat/hc/en-us/articles/33257714954001-Heartbeat-API.
Working Machines stores provider credentials behind the execution boundary. An agent can use an authorized connection identity, but catalog discovery alone does not reveal OAuth tokens, API keys, or provider secrets.
- READ SIGNALS
- 7
- WRITE SIGNALS
- 0
- HIGH IMPACT
- 0
- REVIEW SIGNALS
- 0
EVIDENCE AND AVAILABILITY
Provider reference
Action names, input fields, authentication types, and counts on this page are generated from the Working Machines provider catalog. Provider behavior, quotas, object semantics, account eligibility, and regional availability remain governed by Heartbeat.