Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

beehiiv Config (BYOK) — connector documentation

  • MCP endpoint: https://byok-beehiiv-config.connectorbay.com/mcp
  • REST API: POST https://byok-beehiiv-config.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-beehiiv-config.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own beehiiv Config API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-beehiiv-config.connectorbay.com/health · Tool schemas: https://byok-beehiiv-config.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-beehiiv-config · agent@connectorbay.com

What beehiiv Config (BYOK) is for

beehiiv Config (BYOK) lets an AI assistant read your own beehiiv Config data through the beehiiv Config API with a key you supply (API key). Read-only: 10 tools (get_workspace, list_custom_fields, list_tiers, list_newsletter_lists, list_condition_sets, list_webhooks, list_post_templates, list_authors, get_referral_program, get_engagement_totals). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.beehiiv.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by beehiiv Config. beehiiv Config and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which beehiiv workspace is my API key for?"
  • "What custom subscriber fields exist on my beehiiv publication?"
  • "Which subscription tiers does my beehiiv publication have?"
  • "Which newsletter lists exist on my beehiiv publication and how many subscribers do they have?"
  • "Which dynamic content condition sets are defined in beehiiv?"
  • "Which beehiiv webhooks are configured and what events do they receive?"

What it does

  • get_workspace: Show the beehiiv workspace the key belongs to: workspace id and name.
  • list_custom_fields: List a publication's custom field definitions: id, display name, kind (string, integer, boolean, date, datetime, list, double), creation time and list options. No subscriber values.
  • list_tiers: List a publication's subscription tiers with id, name, status (active or archived) and description. Prices and subscriber counts are not requested.
  • list_newsletter_lists: List newsletter lists (topic-based mailing lists) with name, slug, status, auto-subscribe flag, preference center visibility and subscriber count.
  • list_condition_sets: List dynamic-content condition sets (audience rules) with id, name, status and purpose.
  • list_webhooks: List a publication's webhook endpoints with subscribed event types, description and dates. Target URLs are not returned.
  • list_post_templates: List a publication's post templates with id, name, description and dates.
  • list_authors: List a publication's authors (team users and guest authors) with id, type and name. Bios and social links are not returned.
  • get_referral_program: Get the referral program setup: reward name, type (physical, promo_code, digital, premium_gift), referral count needed and auto-fulfill flag.
  • get_engagement_totals: Get aggregate email engagement per day, week or month: total and unique opens, total and unique clicks and verified clicks.

BYOK key

You bring your own beehiiv Config API key (https://developers.beehiiv.com/welcome/create-an-api-key). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.beehiiv.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the beehiiv Config API (api.beehiiv.com) with a BYOK key; documentation: https://developers.beehiiv.com/api-reference/publications/index.md. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by beehiiv Config. beehiiv Config and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your beehiiv Config account.

Built for: Worldwide. Languages: English.