> For the complete documentation index, see [llms.txt](https://notara.gitbook.io/notara-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://notara.gitbook.io/notara-docs/connectors/beehiiv.md).

# Beehiiv

Read newsletter posts, subscriber data, audience segments, and publication-level stats from your beehiiv publication.

## What It Enables

| Tool                        | Capability | Description                                                |
| --------------------------- | ---------- | ---------------------------------------------------------- |
| `list_posts`                | `read`     | List posts with per-post email and web stats, newest first |
| `get_post`                  | `read`     | Get one post with full stats and per-link click counts     |
| `list_subscriptions`        | `read`     | List subscribers with status, tier, and acquisition source |
| `get_subscription_by_email` | `read`     | Look up one subscriber by email address                    |
| `list_segments`             | `read`     | List audience segments with size and last-calculated time  |
| `get_publication_stats`     | `read`     | Get headline numbers — subscribers, open rate, click rate  |

All tools are read-only.

## Setup

**Required:** beehiiv API key and Publication ID

**Where to find them:** [app.beehiiv.com → Settings → API](https://app.beehiiv.com/settings/api)

1. In the Notara dashboard, go to **Tools**.
2. Click the **beehiiv** tile.
3. In beehiiv, go to **Settings → API** and generate an API key.
4. Copy your Publication ID from the same page (starts with `pub_`).
5. Paste both into the connector fields and click **Verify & Save**.

Your API key is encrypted at rest with AES-256-GCM.

## Example Prompts

> "How did last week's newsletter perform — open rate, clicks, and top links?"

> "What's the current subscriber count and average open rate?"

> "Which acquisition source has driven the most subscribers this month?"


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://notara.gitbook.io/notara-docs/connectors/beehiiv.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.