Heartbeat Readme Heartbeat API

Name: Heartbeat API
Brand: Heartbeat API
Availability: InStock

✓ Official Vendor SpecCommunicationsChat Messagingbearer53 EndpointsREST

For Agents

Manage Heartbeat community users, invitations, roles, groups, channels, threads, and notifications through the full v0 REST surface, with bearer-authenticated calls.

Install Jentic One Beta

Connect the Heartbeat API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Heartbeat API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Heartbeat API.

Manage member lifecycles end-to-end via /users, /pendingUser, and /users/reactivate

Issue and track community invitations through /invitations and /invitations/{invitationID}

Assign and inspect community roles through /roles and group membership through /groups

GET STARTED

Start building with Heartbeat API

Explore with Jentic

View OpenAPI Document

This is the full Heartbeat community platform API as published through Heartbeat's developer documentation on heartbeat.readme.io. It covers the same v0 endpoints as the core spec — users, channels, threads, comments — and adds management surfaces for invitations, pending users, notifications, roles, and groups, plus broader CRUD coverage on every resource. Community operators use it to deeply integrate Heartbeat with internal systems, run governance workflows like role assignment and invitation tracking, and pull notification streams for external dashboards.

Use Cases

Patterns agents use Heartbeat API for, with concrete tasks.

★ Invitation Lifecycle Automation

Drive Heartbeat invitations from your CRM or onboarding tool. PUT /invitations to create an invitation when a customer signs a contract, GET /invitations to track which ones are still pending, and POST /invitations/{invitationID} to update or revoke them. This keeps community access aligned with your customer lifecycle without manual admin work in the Heartbeat dashboard.

PUT /invitations with the new customer's email, then GET /invitations to confirm the invitation appears as pending

Role and Group Governance

Use /roles and /groups to programmatically grant moderators, course creators, or VIP members the right access. Combine with /users to bind specific members to roles, and audit by reading the same endpoints on a schedule. This makes role drift visible and recoverable instead of being buried in admin UI clicks.

GET /roles and /groups, then update group membership via PUT /groups for the moderator group with the latest moderator list

Notification Stream Integration

Pipe member notifications from Heartbeat into your internal dashboards by polling /notifications. This lets you display unread mentions and replies in another tool — for example, a customer success workspace — alongside other signals about a member. Acknowledge or mark notifications read through the same surface to keep state consistent.

GET /notifications for a userID, filter unread, and surface them in an internal dashboard

AI Agent Community Governance via Jentic

A community-ops agent searches Jentic for 'invite a user to a community' and Jentic returns the Heartbeat /invitations operation. The agent issues invitations from CRM events, assigns roles based on customer tier, and revokes invitations on churn — all without holding the bearer token directly because Jentic vaults it. This makes the full Heartbeat governance surface composable from a copilot.

Use Jentic search 'invite a user to a community' to load /invitations and execute with the new customer's email

Key Endpoints

53 endpoints — this is the full heartbeat community platform api as published through heartbeat's developer documentation on heartbeat.

METHOD

PATH

DESCRIPTION

GET

/users

List members

POST

/users

Create a member

PUT

/invitations

Create an invitation

GET

/invitations

List invitations

POST

/invitations/{invitationID}

Update or revoke an invitation

GET

/roles

List community roles

GET

/groups

List community groups

GET

/notifications

Read notifications

GET

/users

List members

POST

/users

Create a member

PUT

/invitations

Create an invitation

GET

/invitations

List invitations

POST

/invitations/{invitationID}

Update or revoke an invitation

GET

/roles

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Heartbeat bearer tokens grant full read and write rights across the community, including invitations and roles. Jentic stores the token in the vault (MAXsystem) and injects the Authorization header at execution time.

Intent-based discovery

Agents search Jentic for 'invite a user to a community' or 'list community roles' and Jentic returns the matching /invitations, /roles, or /groups operations under heartbeat.readme.io with their input schemas.

Time to first call

Direct Heartbeat integration: 2-3 days to wire users, invitations, roles, and notifications consistently. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using Heartbeat API through Jentic.

What authentication does the Heartbeat API use?

The API uses HTTP Bearer authentication. Pass your Heartbeat token in the Authorization header on every call. Jentic stores the token in the vault and attaches it for each request.

Can I issue community invitations through the API?

Yes. PUT /invitations to create one, GET /invitations to list pending invitations, and POST /invitations/{invitationID} to update or revoke. Invitation status flows through the same endpoints as the dashboard uses.

How do I list community roles and groups?

GET /roles returns the available role definitions and GET /groups returns the configured groups. Use these alongside /users to assign members or audit access at scale.

What are the rate limits for the Heartbeat API?

Heartbeat does not document a public per-account rate limit. For high-volume governance jobs, batch reads and back off on HTTP 429 — the bearer token is shared across all v0 endpoints, so a single throttled request affects the whole job.

How do I invite a user through Jentic?

Search Jentic for 'invite a user to a community', load the PUT /invitations operation for heartbeat.readme.io, and execute with the new user's email. Jentic injects the bearer token from the vault.

How does this API differ from heartbeat.chat?

Both specs target the same base URL (api.heartbeat.chat/v0). The heartbeat.chat spec covers the core 23 endpoints, while this spec — sourced from heartbeat.readme.io — covers the full 53 endpoints including invitations, roles, groups, and notifications. Use this one when you need governance and notification operations.

Heartbeat Readme Heartbeat API

Connect the Heartbeat API to your agent

Capabilities

Start building with Heartbeat API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs