Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
beehiiv API integration with managed OAuth. Manage newsletter publications, subscriptions, posts, custom fields, segments, and automations. Use this skill when users want to manage newsletter subscribers, create posts, organize segments, or integrate with beehiiv publications. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Requires network access and valid Maton API key.
beehiiv API integration with managed OAuth. Manage newsletter publications, subscriptions, posts, custom fields, segments, and automations. Use this skill when users want to manage newsletter subscribers, create posts, organize segments, or integrate with beehiiv publications. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Requires network access and valid Maton API key.
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Access the beehiiv API with managed OAuth authentication. Manage newsletter publications, subscriptions, posts, custom fields, segments, tiers, and automations.
# List publications python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/beehiiv/v2/publications') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF
https://gateway.maton.ai/beehiiv/{native-api-path} Replace {native-api-path} with the actual beehiiv API endpoint path. The gateway proxies requests to api.beehiiv.com and automatically injects your OAuth token.
All requests require the Maton API key in the Authorization header: Authorization: Bearer $MATON_API_KEY Environment Variable: Set your API key as MATON_API_KEY: export MATON_API_KEY="YOUR_API_KEY"
Sign in or create an account at maton.ai Go to maton.ai/settings Copy your API key
Manage your beehiiv OAuth connections at https://ctrl.maton.ai.
python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections?app=beehiiv&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF
python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'beehiiv'}).encode() req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF
python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF Response: { "connection": { "connection_id": "8bfe17f4-0038-4cbd-afb4-907b1ffa9d66", "status": "ACTIVE", "creation_time": "2026-02-11T00:25:10.464852Z", "last_updated_time": "2026-02-11T00:27:00.816431Z", "url": "https://connect.maton.ai/?session_token=...", "app": "beehiiv", "metadata": {} } } Open the returned url in a browser to complete OAuth authorization.
python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF
If you have multiple beehiiv connections, specify which one to use with the Maton-Connection header: python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/beehiiv/v2/publications') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Maton-Connection', '8bfe17f4-0038-4cbd-afb4-907b1ffa9d66') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF If omitted, the gateway uses the default (oldest) active connection.
All beehiiv API endpoints follow this pattern: /beehiiv/v2/{resource}
GET /beehiiv/v2/publications Query Parameters: ParameterDescriptionlimitResults per page (1-100, default: 10)pagePage number (default: 1)expand[]Expand with: stats, stat_active_subscriptions, stat_average_open_rate, etc.order_bySort by: created or namedirectionSort direction: asc or desc Response: { "data": [ { "id": "pub_c6c521e4-91ac-4c14-8a52-06987b7e32f2", "name": "My Newsletter", "organization_name": "My Organization", "referral_program_enabled": true, "created": 1770767522 } ], "page": 1, "limit": 10, "total_results": 1, "total_pages": 1 }
GET /beehiiv/v2/publications/{publication_id}
GET /beehiiv/v2/publications/{publication_id}/subscriptions Query Parameters: ParameterDescriptionlimitResults per page (1-100, default: 10)cursorCursor for pagination (recommended)pagePage number (deprecated, max 100 pages)emailFilter by exact email (case-insensitive)statusFilter: validating, invalid, pending, active, inactive, alltierFilter: free, premium, allexpand[]Expand with: stats, custom_fields, referralsorder_bySort field (default: created)directionSort direction: asc or desc Response: { "data": [ { "id": "sub_c27d9640-f418-43a8-a0f9-528c20a05002", "email": "subscriber@example.com", "status": "active", "created": 1770767524, "subscription_tier": "free", "subscription_premium_tier_names": [], "utm_source": "direct", "utm_medium": "", "utm_channel": "website", "utm_campaign": "", "referring_site": "", "referral_code": "gBZbSVal1X", "stripe_customer_id": "" } ], "limit": 10, "has_more": false, "next_cursor": null }
GET /beehiiv/v2/publications/{publication_id}/subscriptions/{subscription_id} Query Parameters: ParameterDescriptionexpand[]Expand with: stats, custom_fields, referrals, tags
GET /beehiiv/v2/publications/{publication_id}/subscriptions/by_email/{email}
POST /beehiiv/v2/publications/{publication_id}/subscriptions Content-Type: application/json { "email": "newsubscriber@example.com", "utm_source": "api", "send_welcome_email": false, "reactivate_existing": false } Request Body: FieldTypeRequiredDescriptionemailstringYesSubscriber email addressreactivate_existingbooleanNoReactivate if previously unsubscribedsend_welcome_emailbooleanNoSend welcome emailutm_sourcestringNoUTM source for trackingutm_mediumstringNoUTM mediumreferring_sitestringNoReferral code of referring subscribercustom_fieldsobjectNoCustom field values (fields must exist)double_opt_overridestringNoon or off to override double opt-intierstringNoSubscription tierpremium_tier_namesarrayNoPremium tier names to assign
PATCH /beehiiv/v2/publications/{publication_id}/subscriptions/{subscription_id} Content-Type: application/json { "utm_source": "updated-source", "custom_fields": [ {"name": "First Name", "value": "John"} ] }
DELETE /beehiiv/v2/publications/{publication_id}/subscriptions/{subscription_id}
GET /beehiiv/v2/publications/{publication_id}/posts Query Parameters: ParameterDescriptionlimitResults per page (1-100, default: 10)pagePage numberstatusFilter by statusexpand[]Expand with additional data Response: { "data": [], "page": 1, "limit": 10, "total_results": 0, "total_pages": 0 }
GET /beehiiv/v2/publications/{publication_id}/posts/{post_id}
DELETE /beehiiv/v2/publications/{publication_id}/posts/{post_id}
GET /beehiiv/v2/publications/{publication_id}/custom_fields Response: { "data": [ { "id": "95c9653f-a1cf-45f0-a140-97feef19057b", "kind": "string", "display": "Last Name", "created": 1770767523 }, { "id": "4cfe081e-c89b-4da5-9c1a-52a4fb8ba69e", "kind": "string", "display": "First Name", "created": 1770767523 } ], "page": 1, "limit": 10, "total_results": 2, "total_pages": 1 } Field Kinds: string, integer, boolean, date, datetime, list, double
POST /beehiiv/v2/publications/{publication_id}/custom_fields Content-Type: application/json { "display": "Company", "kind": "string" }
PATCH /beehiiv/v2/publications/{publication_id}/custom_fields/{custom_field_id} Content-Type: application/json { "display": "Company Name" }
DELETE /beehiiv/v2/publications/{publication_id}/custom_fields/{custom_field_id}
GET /beehiiv/v2/publications/{publication_id}/segments Response: { "data": [], "page": 1, "limit": 10, "total_results": 0, "total_pages": 0 }
GET /beehiiv/v2/publications/{publication_id}/segments/{segment_id}
DELETE /beehiiv/v2/publications/{publication_id}/segments/{segment_id}
GET /beehiiv/v2/publications/{publication_id}/tiers
GET /beehiiv/v2/publications/{publication_id}/tiers/{tier_id}
POST /beehiiv/v2/publications/{publication_id}/tiers Content-Type: application/json { "name": "Premium", "description": "Premium tier with exclusive content" }
PATCH /beehiiv/v2/publications/{publication_id}/tiers/{tier_id} Content-Type: application/json { "name": "Updated Tier Name" }
GET /beehiiv/v2/publications/{publication_id}/automations
GET /beehiiv/v2/publications/{publication_id}/automations/{automation_id}
GET /beehiiv/v2/publications/{publication_id}/referral_program
beehiiv supports two pagination methods:
GET /beehiiv/v2/publications/{publication_id}/subscriptions?limit=10&cursor={next_cursor} Response includes: { "data": [...], "limit": 10, "has_more": true, "next_cursor": "eyJ0aW1lc3RhbXAiOiIyMDI0LTA3LTAyVDE3OjMwOjAwLjAwMDAwMFoifQ==" } Use the next_cursor value for subsequent requests.
GET /beehiiv/v2/publications?page=2&limit=10 Response includes: { "data": [...], "page": 2, "limit": 10, "total_results": 50, "total_pages": 5 } Note: Page-based pagination is limited to 100 pages maximum.
const response = await fetch( 'https://gateway.maton.ai/beehiiv/v2/publications', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ); const data = await response.json(); console.log(data.data);
import os import requests response = requests.get( 'https://gateway.maton.ai/beehiiv/v2/publications', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'} ) data = response.json() for pub in data['data']: print(f"{pub['id']}: {pub['name']}")
Publication IDs start with pub_ Subscription IDs start with sub_ Timestamps are Unix timestamps (seconds since epoch) Custom fields must be created before use in subscriptions Cursor-based pagination is recommended for better performance Page-based pagination is deprecated and limited to 100 pages IMPORTANT: When using curl commands, use curl -g when URLs contain brackets to disable glob parsing IMPORTANT: When piping curl output to jq or other commands, environment variables like $MATON_API_KEY may not expand correctly in some shell environments
StatusMeaning400Bad request or invalid parameters401Invalid or missing Maton API key403Forbidden - insufficient permissions or plan limitation404Resource not found429Rate limited500Internal server error
Check that the MATON_API_KEY environment variable is set: echo $MATON_API_KEY Verify the API key is valid by listing connections: python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF
Ensure your URL path starts with beehiiv. For example: Correct: https://gateway.maton.ai/beehiiv/v2/publications Incorrect: https://gateway.maton.ai/v2/publications
beehiiv Developer Documentation beehiiv API Reference beehiiv Help Center Maton Community Maton Support
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Largest current source with strong distribution and engagement signals.