Heartbeat

Last updated:

The Heartbeat app simply sends one event to your project every minute for as long as it is enabled. It's mainly useful for testing and works well in conjunction with the Ingestion Alert app.

Requirements

The Heartbeat app doesn't require a living heart, but it does require either PostHog Cloud, or a self-hosted PostHog instance running version 1.30.0 or later.

Not running 1.30.0? Find out how to update your self-hosted PostHog deployment!

Installation

  1. Log in to your PostHog instance
  2. Click 'Apps' on the left-hand tool bar
  3. Search for 'Heartbeat' press 'Install'
  4. Configure the by app by following the instructions below.

Configuration

OptionDescription
Events to be emitted
Type: choice
Required: True
The basic heartbeat event emitted by this plugin goes straight into the event ingestion queue. The heartbeat_buffer is emitted the same way as heartbeat, but has a different distinct ID each time to ensure it goes via the event buffer. The heartbeat_api event goes via the event capture endpoint, which helps monitor the API too.
PostHog host with protocol (only for `heartbeat_api`)
Type: string
Required: False
PostHog project API key (only for `heartbeat_api`)
Type: string
Required: False

FAQ

Is the source code for this app available?

PostHog is open-source and so are all apps on the platform. The source code for the Heartbeat app is available on GitHub.

Who created this app?

We'd like to thank Marcus Hyett for creating the Heartbeat app. Thanks, Marcus!

Who maintains this app?

This app is maintained by PostHog. If you have issues with the app not functioning as intended, please let us know!

What if I have feedback on this app?

We love feature requests and feedback! Please tell us what you think! to tell us what you think.

Or, if you see the feedback widget enabled, use that!

What if my question isn't answered above?

We love answering questions. Ask us anything via our community forum, or drop us a message.

Questions?

Was this page useful?

Next article

Ingestion Alert

This app triggers a webhook when no events have been ingested for a specified period of time. It can be used to alert you when ingestion for your project / instance is not working correctly. Requirements The Ingestion Alert app requires either PostHog Cloud, or a self-hosted PostHog instance running version 1.30.0 or later. Not running 1.30.0? Find out how to update your self-hosted PostHog deployment ! Installation Log in to your PostHog instance Click 'Apps' on the left-hand tool bar Search…

Read next article