Skip to main content

beehiiv

Manage beehiiv newsletter subscribers, posts and publication stats.

Connect it with: API key. beehiiv's own documentation: https://developers.beehiiv.com/api-reference/publications/index.

What agents can do​

Connect beehiiv so the agents working your tasks can reach it. With it connected, they can:

  • List the workspace's publications and read their subscriber and open-rate stats.
  • Add a new subscriber, update one's custom fields, or unsubscribe one.
  • List recent posts and read each post's opens, clicks and web views.
  • Find a subscriber by email to answer a support question.

Before you start​

  • A beehiiv workspace and a role in it that may create API keys (owner or admin).
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with beehiiv​

Jaah connects to beehiiv with an API key, not with a sign-in button.

Connect with an API key​

Find each value first:

  • API key: beehiiv dashboard > Settings > Workspace settings > API > Create new API key. Name it Jaah; beehiiv shows the key once.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the beehiiv card.
  2. Name the secret and choose who can use it.
  3. Fill in API key.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to beehiiv with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls beehiiv's API once (GET https://api.beehiiv.com/v2/publications?limit=1) with the stored values, and shows whether beehiiv accepted it, or which value beehiiv refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: api_key.

Tell the agent in your task description which secret to use, for example “use the beehiiv secret org/beehiiv”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at beehiiv once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at beehiiv's side too, revoke or delete the key at beehiiv.

Limitations​

  • An API key reaches every publication in the workspace; beehiiv has no per-publication key.
  • Some endpoints, such as creating posts, need a paid beehiiv plan.
  • beehiiv rate-limits the API per key; a large subscriber import should run in batches.
  • Agents can do only what the connected beehiiv account allows.

Troubleshooting​

Test says beehiiv rejected the API key (401)

The key was deleted or mistyped. Create a new key under Settings > Workspace settings > API and select Replace on the secret.

An agent gets 404 for a publication

Publication IDs start with pub_. Ask the agent to list publications first and use the ID it shows.

An agent gets 403 on creating a post

Your beehiiv plan does not include that endpoint. Upgrade the plan or have the agent draft the post for you to paste.

Still stuck? Select Test and read the result: it names the value beehiiv refused and the status it answered.

FAQ​

Can agents send a newsletter?

They can create a post through the API where your plan allows it; sending stays a step you take in beehiiv unless the task says otherwise.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one beehiiv account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.