Beehiiv is an email newsletter platform built for writers and creators. It provides tools for composing, sending, and monetizing newsletters, and is used by individuals and organizations looking to build and engage their audience through email.
Official docs: https://www.beehiv.io/resources/
Use action names and parameters as needed.
This skill uses the Membrane CLI to interact with Beehiiv. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.
Install the Membrane CLI so you can run membrane from the terminal:
npm install -g @membranehq/cli
membrane login --tenant
A browser window opens for authentication.
Headless environments: Run the command, copy the printed URL for the user to open in a browser, then complete with membrane login complete .
```bash
membrane search beehiiv --elementType=connector --json
```
Take the connector ID from output.items[0].element?.id, then:
```bash
membrane connect --connectorId=CONNECTOR_ID --json
```
The user completes authentication in the browser. The output contains the new connection id.
When you are not sure if connection already exists:
```bash
membrane connection list --json
```
If a Beehiiv connection exists, note its connectionId
When you know what you want to do but not the exact action ID:
membrane action list --intent=QUERY --connectionId=CONNECTION_ID --json
This will return action objects with id and inputSchema in it, so you will know how to run it.
| Name | Key | Description |
|---|---|---|
| --- | --- | --- |
| Add Subscription to Automation | add-subscription-to-automation | Add a subscription to an automation journey |
| List Automations | list-automations | Retrieve a list of automations for a publication |
| List Tiers | list-tiers | Retrieve a list of tiers (subscription levels) for a publication |
| Create Custom Field | create-custom-field | Create a new custom field for a publication |
| List Custom Fields | list-custom-fields | Retrieve a list of custom fields for a publication |
| Get Segment | get-segment | Retrieve a specific segment by ID |
| List Segments | list-segments | Retrieve a list of segments for a publication |
| Delete Post | delete-post | Delete a post by ID |
| Get Post | get-post | Retrieve a specific post by ID |
| Create Post | create-post | Create a new post (newsletter) for a publication |
| List Posts | list-posts | Retrieve a list of posts for a publication |
| Add Subscription Tags | add-subscription-tags | Add tags to a subscription |
| Delete Subscription | delete-subscription | Delete a subscription by ID |
| Update Subscription | update-subscription | Update an existing subscription by ID |
| Get Subscription by Email | get-subscription-by-email | Retrieve a subscription by email address |
| Get Subscription by ID | get-subscription-by-id | Retrieve a subscription by its ID |
| Create Subscription | create-subscription | Create a new subscription (subscriber) for a publication |
| List Subscriptions | list-subscriptions | Retrieve a list of subscriptions (subscribers) for a publication |
| Get Publication | get-publication | Retrieve details of a specific publication by ID |
| List Publications | list-publications | Retrieve a list of all publications in your workspace |
membrane action run --connectionId=CONNECTION_ID ACTION_ID --json
To pass JSON parameters:
membrane action run --connectionId=CONNECTION_ID ACTION_ID --json --input "{ \"key\": \"value\" }"
When the available actions don't cover your use case, you can send requests directly to the Beehiiv API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.
membrane request CONNECTION_ID /path/to/endpoint
Common options:
| Flag | Description |
|---|---|
| ------ | ------------- |
-X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET |
-H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" |
-d, --data | Request body (string) |
--json | Shorthand to send a JSON body and set Content-Type: application/json |
--rawData | Send the body as-is without any processing |
--query | Query-string parameter (repeatable), e.g. --query "limit=10" |
--pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |
membrane action list --intent=QUERY (replace QUERY with your intent) to find existing actions before writing custom API calls. Pre-built actions handle pagination, field mapping, and edge cases that raw API calls miss.共 2 个版本