Email marketing
beehiiv in your product and your AI agents, through one API
The beehiiv toolkit covers publications, subscriptions, subscription tags, posts and aggregate post statistics. Your customer connects once with an API key, and your product or AI agent calls each operation through Connect, which stores the credential and logs every execution.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/beehiiv_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>",
"email": "<email>"
}
}How it works
From a connected customer to the first beehiiv call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their beehiiv account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with beehiiv.
Sync signups to a newsletter
When a user signs up in your SaaS, create a subscription in the customer's publication and tag it with the plan or source.
Publish content from your product
Create a post from HTML as a draft or schedule it, so a content tool can push newsletters to beehiiv without its own integration.
Newsletter reports for agents
Let an AI agent list posts and read aggregate stats such as opens, clicks and most clicked links to summarize how a publication is doing.
Tools
12 beehiiv tools
- List publicationsGETLists the publications the API key reaches, with id, name and organization_name. expand stats adds active subscriptions, average open and click rates and totals sent. Page with page and limit, up to 100; the response has total_pages.
- List subscriptionsGETLists the subscriptions (subscribers) of a publication, optionally only one email, status or tier. Page with limit, up to 100, and cursor: the response has has_more and next_cursor.
- Get subscriptionGETReturns one subscription with email, status, created, subscription_tier, the utm fields and referral_code.
- Create subscriptionPOSTSubscribes an email to a publication and returns the subscription with its id. With double opt-in on the publication, or double_opt_override on, the person confirms by email before becoming active.
- Update subscriptionPATCHUpdates a subscription. Only the fields sent change. unsubscribe true unsubscribes the person from the publication.
- Create subscription tagPOSTAdds tags to a subscription. A tag that does not exist in the publication yet is created.
- List postsGETLists the posts of a publication with id, title, subtitle, status, publish_date and web_url. expand stats adds the email and web statistics of each post. Page with page and limit, up to 100; the response has total_pages.
- Get postGETReturns one post; expand stats adds its email and web statistics. A post created moments ago can answer 202 while beehiiv builds it, and 404 with POST_CREATION_FAILED when the creation failed.
- Create postPOSTCreates a post from HTML and returns its id; only on the Pro and Enterprise plans. status draft, the default, only saves it; confirmed sends and publishes it right away or at scheduled_at. beehiiv builds the post in the background, so Get post can answer 202 for a moment.
- Update postPATCHUpdates a post; only on the Pro and Enterprise plans. Only the fields sent change, and body_content replaces the whole content. scheduled_at cannot change after the post was sent.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
Questions about the beehiiv toolkit
Do I need to build against the beehiiv API?
No. Connect ships 12 beehiiv tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their beehiiv account?
With the mode the toolkit accepts: API key. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
