Can I use beehiiv as a CLI?

Yes. KosmoKrator exposes a beehiiv CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose beehiiv through MCP?

Yes. The KosmoKrator MCP gateway can expose selected beehiiv tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are beehiiv credentials stored?

beehiiv credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for beehiiv MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

beehiiv Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the beehiiv KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.beehiiv.*. Use lua_read_doc("integrations.beehiiv") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic beehiiv workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.beehiiv.get_advertisement_opportunities_oauth_scope_posts_read({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("beehiiv"))' --json
kosmo integrations:lua --eval 'print(docs.read("beehiiv.get_advertisement_opportunities_oauth_scope_posts_read"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local beehiiv = app.integrations.beehiiv
local result = beehiiv.get_advertisement_opportunities_oauth_scope_posts_read({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.beehiiv, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.beehiiv.default.* or app.integrations.beehiiv.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need beehiiv, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

beehiiv Lua Tools

Namespace: beehiiv

The beehiiv integration exposes 82 operations from the official OpenAPI specification. Use these tools for publications, posts, subscriptions, bulk subscription jobs, segments, automations, custom fields, newsletter lists, webhooks, tiers, polls, and workspace/user identification.

Auth

Configure api_key. Configure publication_id once to omit it from publication-scoped calls, or pass publication_id per call.

Examples

local publications = app.integrations.beehiiv.publications_index({})

local posts = app.integrations.beehiiv.posts_index({
  publication_id = "pub_00000000-0000-0000-0000-000000000000",
  limit = 10
})

local subscription = app.integrations.beehiiv.subscriptions_create({
  body = {
    email = "reader@example.test",
    reactivate_existing = false,
    send_welcome_email = false
  }
})

Common Tools

Tool	Endpoint	Area
`beehiiv_advertisement_opportunities_index`	GET `/publications/{publicationId}/advertisement_opportunities`	AdvertisementOpportunities
`beehiiv_authors_index`	GET `/publications/{publicationId}/authors`	Authors
`beehiiv_authors_show`	GET `/publications/{publicationId}/authors/{authorId}`	Authors
`beehiiv_automation_journeys_create`	POST `/publications/{publicationId}/automations/{automationId}/journeys`	AutomationJourneys
`beehiiv_automation_journeys_index`	GET `/publications/{publicationId}/automations/{automationId}/journeys`	AutomationJourneys
`beehiiv_automation_journeys_show`	GET `/publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}`	AutomationJourneys
`beehiiv_automations_index`	GET `/publications/{publicationId}/automations`	Automations
`beehiiv_automations_list_emails`	GET `/publications/{publicationId}/automations/{automationId}/emails`	Automations
`beehiiv_automations_show`	GET `/publications/{publicationId}/automations/{automationId}`	Automations
`beehiiv_bulk_subscription_updates_index`	GET `/publications/{publicationId}/bulk_subscription_updates`	BulkSubscriptionUpdates
`beehiiv_bulk_subscription_updates_patch`	PATCH `/publications/{publicationId}/subscriptions/bulk_actions`	BulkSubscriptionUpdates
`beehiiv_bulk_subscription_updates_patch_status`	PATCH `/publications/{publicationId}/subscriptions`	BulkSubscriptionUpdates
`beehiiv_bulk_subscription_updates_put`	PUT `/publications/{publicationId}/subscriptions/bulk_actions`	BulkSubscriptionUpdates
`beehiiv_bulk_subscription_updates_put_status`	PUT `/publications/{publicationId}/subscriptions`	BulkSubscriptionUpdates
`beehiiv_bulk_subscription_updates_show`	GET `/publications/{publicationId}/bulk_subscription_updates/{id}`	BulkSubscriptionUpdates
`beehiiv_bulk_subscriptions_create`	POST `/publications/{publicationId}/bulk_subscriptions`	BulkSubscriptions
`beehiiv_condition_sets_index`	GET `/publications/{publicationId}/condition_sets`	ConditionSets
`beehiiv_condition_sets_show`	GET `/publications/{publicationId}/condition_sets/{conditionSetId}`	ConditionSets
`beehiiv_custom_fields_create`	POST `/publications/{publicationId}/custom_fields`	CustomFields
`beehiiv_custom_fields_delete`	DELETE `/publications/{publicationId}/custom_fields/{id}`	CustomFields
`beehiiv_custom_fields_index`	GET `/publications/{publicationId}/custom_fields`	CustomFields
`beehiiv_custom_fields_patch`	PATCH `/publications/{publicationId}/custom_fields/{id}`	CustomFields
`beehiiv_custom_fields_put`	PUT `/publications/{publicationId}/custom_fields/{id}`	CustomFields
`beehiiv_custom_fields_show`	GET `/publications/{publicationId}/custom_fields/{id}`	CustomFields
`beehiiv_data_deletion_create`	POST `/publications/{publicationId}/data_privacy/deletion_requests`	DataDeletion
`beehiiv_data_deletion_index`	GET `/publications/{publicationId}/data_privacy/deletion_requests`	DataDeletion
`beehiiv_data_deletion_show`	GET `/publications/{publicationId}/data_privacy/deletion_requests/{id}`	DataDeletion
`beehiiv_email_blasts_index`	GET `/publications/{publicationId}/email_blasts`	EmailBlasts
`beehiiv_email_blasts_show`	GET `/publications/{publicationId}/email_blasts/{emailBlastId}`	EmailBlasts
`beehiiv_engagements_index`	GET `/publications/{publicationId}/engagements`	Engagements
`beehiiv_newsletter_list_subscriptions_create`	POST `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions`	NewsletterListSubscriptions
`beehiiv_newsletter_list_subscriptions_index`	GET `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions`	NewsletterListSubscriptions
`beehiiv_newsletter_list_subscriptions_show`	GET `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}`	NewsletterListSubscriptions
`beehiiv_newsletter_list_subscriptions_update`	PATCH `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}`	NewsletterListSubscriptions
`beehiiv_newsletter_list_subscriptions_update_by_subscription_id`	PATCH `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}`	NewsletterListSubscriptions
`beehiiv_newsletter_lists_index`	GET `/publications/{publicationId}/newsletter_lists`	NewsletterLists
`beehiiv_newsletter_lists_show`	GET `/publications/{publicationId}/newsletter_lists/{newsletterListId}`	NewsletterLists
`beehiiv_oauth_users_identify`	GET `/users/identify`	OauthUsers
`beehiiv_polls_index`	GET `/publications/{publicationId}/polls`	Polls
`beehiiv_polls_list_responses`	GET `/publications/{publicationId}/polls/{pollId}/responses`	Polls
`beehiiv_polls_show`	GET `/publications/{publicationId}/polls/{pollId}`	Polls
`beehiiv_post_templates_index`	GET `/publications/{publicationId}/post_templates`	PostTemplates
`beehiiv_posts_aggregate_stats`	GET `/publications/{publicationId}/posts/aggregate_stats`	Posts
`beehiiv_posts_create`	POST `/publications/{publicationId}/posts`	Posts
`beehiiv_posts_delete`	DELETE `/publications/{publicationId}/posts/{postId}`	Posts
`beehiiv_posts_index`	GET `/publications/{publicationId}/posts`	Posts
`beehiiv_posts_show`	GET `/publications/{publicationId}/posts/{postId}`	Posts
`beehiiv_posts_update`	PATCH `/publications/{publicationId}/posts/{postId}`	Posts
`beehiiv_publications_index`	GET `/publications`	Publications
`beehiiv_publications_show`	GET `/publications/{publicationId}`	Publications
`beehiiv_referral_program_show`	GET `/publications/{publicationId}/referral_program`	ReferralProgram
`beehiiv_segments_create`	POST `/publications/{publicationId}/segments`	Segments
`beehiiv_segments_delete`	DELETE `/publications/{publicationId}/segments/{segmentId}`	Segments
`beehiiv_segments_expand_results`	GET `/publications/{publicationId}/segments/{segmentId}/results`	Segments
`beehiiv_segments_index`	GET `/publications/{publicationId}/segments`	Segments
`beehiiv_segments_list_members`	GET `/publications/{publicationId}/segments/{segmentId}/members`	Segments
`beehiiv_segments_recalculate`	PUT `/publications/{publicationId}/segments/{segmentId}/recalculate`	Segments
`beehiiv_segments_show`	GET `/publications/{publicationId}/segments/{segmentId}`	Segments
`beehiiv_subscription_tags_create`	POST `/publications/{publicationId}/subscriptions/{subscriptionId}/tags`	SubscriptionTags
`beehiiv_subscriptions_create`	POST `/publications/{publicationId}/subscriptions`	Subscriptions
`beehiiv_subscriptions_delete`	DELETE `/publications/{publicationId}/subscriptions/{subscriptionId}`	Subscriptions
`beehiiv_subscriptions_get_by_email`	GET `/publications/{publicationId}/subscriptions/by_email/{email}`	Subscriptions
`beehiiv_subscriptions_get_by_id`	GET `/publications/{publicationId}/subscriptions/{subscriptionId}`	Subscriptions
`beehiiv_subscriptions_get_by_subscriber_id`	GET `/publications/{publicationId}/subscriptions/by_subscriber_id/{subscriberId}`	Subscriptions
`beehiiv_subscriptions_get_jwt_token`	GET `/publications/{publicationId}/subscriptions/{subscriptionId}/jwt_token`	Subscriptions
`beehiiv_subscriptions_index`	GET `/publications/{publicationId}/subscriptions`	Subscriptions
`beehiiv_subscriptions_patch`	PATCH `/publications/{publicationId}/subscriptions/{subscriptionId}`	Subscriptions
`beehiiv_subscriptions_put`	PUT `/publications/{publicationId}/subscriptions/{subscriptionId}`	Subscriptions
`beehiiv_subscriptions_update_by_email`	PUT `/publications/{publicationId}/subscriptions/by_email/{email}`	Subscriptions
`beehiiv_tiers_create`	POST `/publications/{publicationId}/tiers`	Tiers
`beehiiv_tiers_index`	GET `/publications/{publicationId}/tiers`	Tiers
`beehiiv_tiers_patch`	PATCH `/publications/{publicationId}/tiers/{tierId}`	Tiers
`beehiiv_tiers_put`	PUT `/publications/{publicationId}/tiers/{tierId}`	Tiers
`beehiiv_tiers_show`	GET `/publications/{publicationId}/tiers/{tierId}`	Tiers
`beehiiv_webhooks_create`	POST `/publications/{publicationId}/webhooks`	Webhooks
`beehiiv_webhooks_delete`	DELETE `/publications/{publicationId}/webhooks/{endpointId}`	Webhooks
`beehiiv_webhooks_index`	GET `/publications/{publicationId}/webhooks`	Webhooks
`beehiiv_webhooks_show`	GET `/publications/{publicationId}/webhooks/{endpointId}`	Webhooks
`beehiiv_webhooks_test`	GET `/publications/{publicationId}/webhooks/{endpointId}/tests`	Webhooks
`beehiiv_webhooks_update`	PATCH `/publications/{publicationId}/webhooks/{endpointId}`	Webhooks

The full generated catalog contains all operations from the official beehiiv OpenAPI spec.

Raw agent markdown

# beehiiv Lua Tools

Namespace: `beehiiv`

The beehiiv integration exposes 82 operations from the official OpenAPI specification. Use these tools for publications, posts, subscriptions, bulk subscription jobs, segments, automations, custom fields, newsletter lists, webhooks, tiers, polls, and workspace/user identification.

## Auth

Configure `api_key`. Configure `publication_id` once to omit it from publication-scoped calls, or pass `publication_id` per call.

## Examples

```lua
local publications = app.integrations.beehiiv.publications_index({})

local posts = app.integrations.beehiiv.posts_index({
  publication_id = "pub_00000000-0000-0000-0000-000000000000",
  limit = 10
})

local subscription = app.integrations.beehiiv.subscriptions_create({
  body = {
    email = "reader@example.test",
    reactivate_existing = false,
    send_welcome_email = false
  }
})
```

## Common Tools

| Tool | Endpoint | Area |
|------|----------|------|
| `beehiiv_advertisement_opportunities_index` | GET `/publications/{publicationId}/advertisement_opportunities` | AdvertisementOpportunities |
| `beehiiv_authors_index` | GET `/publications/{publicationId}/authors` | Authors |
| `beehiiv_authors_show` | GET `/publications/{publicationId}/authors/{authorId}` | Authors |
| `beehiiv_automation_journeys_create` | POST `/publications/{publicationId}/automations/{automationId}/journeys` | AutomationJourneys |
| `beehiiv_automation_journeys_index` | GET `/publications/{publicationId}/automations/{automationId}/journeys` | AutomationJourneys |
| `beehiiv_automation_journeys_show` | GET `/publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}` | AutomationJourneys |
| `beehiiv_automations_index` | GET `/publications/{publicationId}/automations` | Automations |
| `beehiiv_automations_list_emails` | GET `/publications/{publicationId}/automations/{automationId}/emails` | Automations |
| `beehiiv_automations_show` | GET `/publications/{publicationId}/automations/{automationId}` | Automations |
| `beehiiv_bulk_subscription_updates_index` | GET `/publications/{publicationId}/bulk_subscription_updates` | BulkSubscriptionUpdates |
| `beehiiv_bulk_subscription_updates_patch` | PATCH `/publications/{publicationId}/subscriptions/bulk_actions` | BulkSubscriptionUpdates |
| `beehiiv_bulk_subscription_updates_patch_status` | PATCH `/publications/{publicationId}/subscriptions` | BulkSubscriptionUpdates |
| `beehiiv_bulk_subscription_updates_put` | PUT `/publications/{publicationId}/subscriptions/bulk_actions` | BulkSubscriptionUpdates |
| `beehiiv_bulk_subscription_updates_put_status` | PUT `/publications/{publicationId}/subscriptions` | BulkSubscriptionUpdates |
| `beehiiv_bulk_subscription_updates_show` | GET `/publications/{publicationId}/bulk_subscription_updates/{id}` | BulkSubscriptionUpdates |
| `beehiiv_bulk_subscriptions_create` | POST `/publications/{publicationId}/bulk_subscriptions` | BulkSubscriptions |
| `beehiiv_condition_sets_index` | GET `/publications/{publicationId}/condition_sets` | ConditionSets |
| `beehiiv_condition_sets_show` | GET `/publications/{publicationId}/condition_sets/{conditionSetId}` | ConditionSets |
| `beehiiv_custom_fields_create` | POST `/publications/{publicationId}/custom_fields` | CustomFields |
| `beehiiv_custom_fields_delete` | DELETE `/publications/{publicationId}/custom_fields/{id}` | CustomFields |
| `beehiiv_custom_fields_index` | GET `/publications/{publicationId}/custom_fields` | CustomFields |
| `beehiiv_custom_fields_patch` | PATCH `/publications/{publicationId}/custom_fields/{id}` | CustomFields |
| `beehiiv_custom_fields_put` | PUT `/publications/{publicationId}/custom_fields/{id}` | CustomFields |
| `beehiiv_custom_fields_show` | GET `/publications/{publicationId}/custom_fields/{id}` | CustomFields |
| `beehiiv_data_deletion_create` | POST `/publications/{publicationId}/data_privacy/deletion_requests` | DataDeletion |
| `beehiiv_data_deletion_index` | GET `/publications/{publicationId}/data_privacy/deletion_requests` | DataDeletion |
| `beehiiv_data_deletion_show` | GET `/publications/{publicationId}/data_privacy/deletion_requests/{id}` | DataDeletion |
| `beehiiv_email_blasts_index` | GET `/publications/{publicationId}/email_blasts` | EmailBlasts |
| `beehiiv_email_blasts_show` | GET `/publications/{publicationId}/email_blasts/{emailBlastId}` | EmailBlasts |
| `beehiiv_engagements_index` | GET `/publications/{publicationId}/engagements` | Engagements |
| `beehiiv_newsletter_list_subscriptions_create` | POST `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions` | NewsletterListSubscriptions |
| `beehiiv_newsletter_list_subscriptions_index` | GET `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions` | NewsletterListSubscriptions |
| `beehiiv_newsletter_list_subscriptions_show` | GET `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}` | NewsletterListSubscriptions |
| `beehiiv_newsletter_list_subscriptions_update` | PATCH `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}` | NewsletterListSubscriptions |
| `beehiiv_newsletter_list_subscriptions_update_by_subscription_id` | PATCH `/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}` | NewsletterListSubscriptions |
| `beehiiv_newsletter_lists_index` | GET `/publications/{publicationId}/newsletter_lists` | NewsletterLists |
| `beehiiv_newsletter_lists_show` | GET `/publications/{publicationId}/newsletter_lists/{newsletterListId}` | NewsletterLists |
| `beehiiv_oauth_users_identify` | GET `/users/identify` | OauthUsers |
| `beehiiv_polls_index` | GET `/publications/{publicationId}/polls` | Polls |
| `beehiiv_polls_list_responses` | GET `/publications/{publicationId}/polls/{pollId}/responses` | Polls |
| `beehiiv_polls_show` | GET `/publications/{publicationId}/polls/{pollId}` | Polls |
| `beehiiv_post_templates_index` | GET `/publications/{publicationId}/post_templates` | PostTemplates |
| `beehiiv_posts_aggregate_stats` | GET `/publications/{publicationId}/posts/aggregate_stats` | Posts |
| `beehiiv_posts_create` | POST `/publications/{publicationId}/posts` | Posts |
| `beehiiv_posts_delete` | DELETE `/publications/{publicationId}/posts/{postId}` | Posts |
| `beehiiv_posts_index` | GET `/publications/{publicationId}/posts` | Posts |
| `beehiiv_posts_show` | GET `/publications/{publicationId}/posts/{postId}` | Posts |
| `beehiiv_posts_update` | PATCH `/publications/{publicationId}/posts/{postId}` | Posts |
| `beehiiv_publications_index` | GET `/publications` | Publications |
| `beehiiv_publications_show` | GET `/publications/{publicationId}` | Publications |
| `beehiiv_referral_program_show` | GET `/publications/{publicationId}/referral_program` | ReferralProgram |
| `beehiiv_segments_create` | POST `/publications/{publicationId}/segments` | Segments |
| `beehiiv_segments_delete` | DELETE `/publications/{publicationId}/segments/{segmentId}` | Segments |
| `beehiiv_segments_expand_results` | GET `/publications/{publicationId}/segments/{segmentId}/results` | Segments |
| `beehiiv_segments_index` | GET `/publications/{publicationId}/segments` | Segments |
| `beehiiv_segments_list_members` | GET `/publications/{publicationId}/segments/{segmentId}/members` | Segments |
| `beehiiv_segments_recalculate` | PUT `/publications/{publicationId}/segments/{segmentId}/recalculate` | Segments |
| `beehiiv_segments_show` | GET `/publications/{publicationId}/segments/{segmentId}` | Segments |
| `beehiiv_subscription_tags_create` | POST `/publications/{publicationId}/subscriptions/{subscriptionId}/tags` | SubscriptionTags |
| `beehiiv_subscriptions_create` | POST `/publications/{publicationId}/subscriptions` | Subscriptions |
| `beehiiv_subscriptions_delete` | DELETE `/publications/{publicationId}/subscriptions/{subscriptionId}` | Subscriptions |
| `beehiiv_subscriptions_get_by_email` | GET `/publications/{publicationId}/subscriptions/by_email/{email}` | Subscriptions |
| `beehiiv_subscriptions_get_by_id` | GET `/publications/{publicationId}/subscriptions/{subscriptionId}` | Subscriptions |
| `beehiiv_subscriptions_get_by_subscriber_id` | GET `/publications/{publicationId}/subscriptions/by_subscriber_id/{subscriberId}` | Subscriptions |
| `beehiiv_subscriptions_get_jwt_token` | GET `/publications/{publicationId}/subscriptions/{subscriptionId}/jwt_token` | Subscriptions |
| `beehiiv_subscriptions_index` | GET `/publications/{publicationId}/subscriptions` | Subscriptions |
| `beehiiv_subscriptions_patch` | PATCH `/publications/{publicationId}/subscriptions/{subscriptionId}` | Subscriptions |
| `beehiiv_subscriptions_put` | PUT `/publications/{publicationId}/subscriptions/{subscriptionId}` | Subscriptions |
| `beehiiv_subscriptions_update_by_email` | PUT `/publications/{publicationId}/subscriptions/by_email/{email}` | Subscriptions |
| `beehiiv_tiers_create` | POST `/publications/{publicationId}/tiers` | Tiers |
| `beehiiv_tiers_index` | GET `/publications/{publicationId}/tiers` | Tiers |
| `beehiiv_tiers_patch` | PATCH `/publications/{publicationId}/tiers/{tierId}` | Tiers |
| `beehiiv_tiers_put` | PUT `/publications/{publicationId}/tiers/{tierId}` | Tiers |
| `beehiiv_tiers_show` | GET `/publications/{publicationId}/tiers/{tierId}` | Tiers |
| `beehiiv_webhooks_create` | POST `/publications/{publicationId}/webhooks` | Webhooks |
| `beehiiv_webhooks_delete` | DELETE `/publications/{publicationId}/webhooks/{endpointId}` | Webhooks |
| `beehiiv_webhooks_index` | GET `/publications/{publicationId}/webhooks` | Webhooks |
| `beehiiv_webhooks_show` | GET `/publications/{publicationId}/webhooks/{endpointId}` | Webhooks |
| `beehiiv_webhooks_test` | GET `/publications/{publicationId}/webhooks/{endpointId}/tests` | Webhooks |
| `beehiiv_webhooks_update` | PATCH `/publications/{publicationId}/webhooks/{endpointId}` | Webhooks |

The full generated catalog contains all operations from the official beehiiv OpenAPI spec.

Metadata-derived Lua example

local result = app.integrations.beehiiv.get_advertisement_opportunities_oauth_scope_posts_read({})
print(result)

Functions

get_advertisement_opportunities_oauth_scope_posts_read Read

Execute official beehiiv API operation `advertisementOpportunities_index`. Endpoint: GET /publications/{publicationId}/advertisement_opportunities.

Lua path: app.integrations.beehiiv.get_advertisement_opportunities_oauth_scope_posts_read
Full name: beehiiv.beehiiv_advertisement_opportunities_index

Parameter	Type	Required	Description
No parameters.

list_authors Read

Execute official beehiiv API operation `authors_index`. Endpoint: GET /publications/{publicationId}/authors.

Lua path: app.integrations.beehiiv.list_authors
Full name: beehiiv.beehiiv_authors_index

Parameter	Type	Required	Description
No parameters.

get_author Read

Execute official beehiiv API operation `authors_show`. Endpoint: GET /publications/{publicationId}/authors/{authorId}.

Lua path: app.integrations.beehiiv.get_author
Full name: beehiiv.beehiiv_authors_show

Parameter	Type	Required	Description
No parameters.

add_subscription_automation_oauth_scope_automations_write Write

Execute official beehiiv API operation `automationJourneys_create`. Endpoint: POST /publications/{publicationId}/automations/{automationId}/journeys.

Lua path: app.integrations.beehiiv.add_subscription_automation_oauth_scope_automations_write
Full name: beehiiv.beehiiv_automation_journeys_create

Parameter	Type	Required	Description
No parameters.

list_automation_journeys_oauth_scope_automations_read Read

Execute official beehiiv API operation `automationJourneys_index`. Endpoint: GET /publications/{publicationId}/automations/{automationId}/journeys.

Lua path: app.integrations.beehiiv.list_automation_journeys_oauth_scope_automations_read
Full name: beehiiv.beehiiv_automation_journeys_index

Parameter	Type	Required	Description
No parameters.

get_automation_journey_oauth_scope_automations_read Read

Execute official beehiiv API operation `automationJourneys_show`. Endpoint: GET /publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}.

Lua path: app.integrations.beehiiv.get_automation_journey_oauth_scope_automations_read
Full name: beehiiv.beehiiv_automation_journeys_show

Parameter	Type	Required	Description
No parameters.

list_automations_oauth_scope_automations_read Read

Execute official beehiiv API operation `automations_index`. Endpoint: GET /publications/{publicationId}/automations.

Lua path: app.integrations.beehiiv.list_automations_oauth_scope_automations_read
Full name: beehiiv.beehiiv_automations_index

Parameter	Type	Required	Description
No parameters.

list_automation_emails Read

Execute official beehiiv API operation `automations_listEmails`. Endpoint: GET /publications/{publicationId}/automations/{automationId}/emails.

Lua path: app.integrations.beehiiv.list_automation_emails
Full name: beehiiv.beehiiv_automations_list_emails

Parameter	Type	Required	Description
No parameters.

get_automation_oauth_scope_automations_read Read

Execute official beehiiv API operation `automations_show`. Endpoint: GET /publications/{publicationId}/automations/{automationId}.

Lua path: app.integrations.beehiiv.get_automation_oauth_scope_automations_read
Full name: beehiiv.beehiiv_automations_show

Parameter	Type	Required	Description
No parameters.

list_subscription_updates_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `bulkSubscriptionUpdates_index`. Endpoint: GET /publications/{publicationId}/bulk_subscription_updates.

Lua path: app.integrations.beehiiv.list_subscription_updates_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_bulk_subscription_updates_index

Parameter	Type	Required	Description
No parameters.

update_subscriptions_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `bulkSubscriptionUpdates_patch`. Endpoint: PATCH /publications/{publicationId}/subscriptions/bulk_actions.

Lua path: app.integrations.beehiiv.update_subscriptions_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_bulk_subscription_updates_patch

Parameter	Type	Required	Description
No parameters.

update_subscriptions_status_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `bulkSubscriptionUpdates_patch-status`. Endpoint: PATCH /publications/{publicationId}/subscriptions.

Lua path: app.integrations.beehiiv.update_subscriptions_status_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_bulk_subscription_updates_patch_status

Parameter	Type	Required	Description
No parameters.

update_subscriptions_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `bulkSubscriptionUpdates_put`. Endpoint: PUT /publications/{publicationId}/subscriptions/bulk_actions.

Lua path: app.integrations.beehiiv.update_subscriptions_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_bulk_subscription_updates_put

Parameter	Type	Required	Description
No parameters.

update_subscriptions_status_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `bulkSubscriptionUpdates_put-status`. Endpoint: PUT /publications/{publicationId}/subscriptions.

Lua path: app.integrations.beehiiv.update_subscriptions_status_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_bulk_subscription_updates_put_status

Parameter	Type	Required	Description
No parameters.

get_subscription_update_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `bulkSubscriptionUpdates_show`. Endpoint: GET /publications/{publicationId}/bulk_subscription_updates/{id}.

Lua path: app.integrations.beehiiv.get_subscription_update_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_bulk_subscription_updates_show

Parameter	Type	Required	Description
No parameters.

bulk_create_subscription_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `bulkSubscriptions_create`. Endpoint: POST /publications/{publicationId}/bulk_subscriptions.

Lua path: app.integrations.beehiiv.bulk_create_subscription_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_bulk_subscriptions_create

Parameter	Type	Required	Description
No parameters.

list_condition_sets_oauth_scope_condition_sets_read Read

Execute official beehiiv API operation `conditionSets_index`. Endpoint: GET /publications/{publicationId}/condition_sets.

Lua path: app.integrations.beehiiv.list_condition_sets_oauth_scope_condition_sets_read
Full name: beehiiv.beehiiv_condition_sets_index

Parameter	Type	Required	Description
No parameters.

get_condition_set_oauth_scope_condition_sets_read Read

Execute official beehiiv API operation `conditionSets_show`. Endpoint: GET /publications/{publicationId}/condition_sets/{conditionSetId}.

Lua path: app.integrations.beehiiv.get_condition_set_oauth_scope_condition_sets_read
Full name: beehiiv.beehiiv_condition_sets_show

Parameter	Type	Required	Description
No parameters.

create_custom_field_oauth_scope_custom_fields_write Write

Execute official beehiiv API operation `customFields_create`. Endpoint: POST /publications/{publicationId}/custom_fields.

Lua path: app.integrations.beehiiv.create_custom_field_oauth_scope_custom_fields_write
Full name: beehiiv.beehiiv_custom_fields_create

Parameter	Type	Required	Description
No parameters.

delete_custom_field_oauth_scope_custom_fields_write Write

Execute official beehiiv API operation `customFields_delete`. Endpoint: DELETE /publications/{publicationId}/custom_fields/{id}.

Lua path: app.integrations.beehiiv.delete_custom_field_oauth_scope_custom_fields_write
Full name: beehiiv.beehiiv_custom_fields_delete

Parameter	Type	Required	Description
No parameters.

list_custom_fields_oauth_scope_custom_fields_read Read

Execute official beehiiv API operation `customFields_index`. Endpoint: GET /publications/{publicationId}/custom_fields.

Lua path: app.integrations.beehiiv.list_custom_fields_oauth_scope_custom_fields_read
Full name: beehiiv.beehiiv_custom_fields_index

Parameter	Type	Required	Description
No parameters.

update_custom_field_oauth_scope_custom_fields_write Write

Execute official beehiiv API operation `customFields_patch`. Endpoint: PATCH /publications/{publicationId}/custom_fields/{id}.

Lua path: app.integrations.beehiiv.update_custom_field_oauth_scope_custom_fields_write
Full name: beehiiv.beehiiv_custom_fields_patch

Parameter	Type	Required	Description
No parameters.

update_custom_field_oauth_scope_custom_fields_write Write

Execute official beehiiv API operation `customFields_put`. Endpoint: PUT /publications/{publicationId}/custom_fields/{id}.

Lua path: app.integrations.beehiiv.update_custom_field_oauth_scope_custom_fields_write
Full name: beehiiv.beehiiv_custom_fields_put

Parameter	Type	Required	Description
No parameters.

get_custom_field_oauth_scope_custom_fields_read Read

Execute official beehiiv API operation `customFields_show`. Endpoint: GET /publications/{publicationId}/custom_fields/{id}.

Lua path: app.integrations.beehiiv.get_custom_field_oauth_scope_custom_fields_read
Full name: beehiiv.beehiiv_custom_fields_show

Parameter	Type	Required	Description
No parameters.

create_data_deletion_request_oauth_scope_data_deletion_write Write

Execute official beehiiv API operation `dataDeletion_create`. Endpoint: POST /publications/{publicationId}/data_privacy/deletion_requests.

Lua path: app.integrations.beehiiv.create_data_deletion_request_oauth_scope_data_deletion_write
Full name: beehiiv.beehiiv_data_deletion_create

Parameter	Type	Required	Description
No parameters.

list_data_deletion_requests_oauth_scope_data_deletion_read Read

Execute official beehiiv API operation `dataDeletion_index`. Endpoint: GET /publications/{publicationId}/data_privacy/deletion_requests.

Lua path: app.integrations.beehiiv.list_data_deletion_requests_oauth_scope_data_deletion_read
Full name: beehiiv.beehiiv_data_deletion_index

Parameter	Type	Required	Description
No parameters.

get_data_deletion_request_oauth_scope_data_deletion_read Read

Execute official beehiiv API operation `dataDeletion_show`. Endpoint: GET /publications/{publicationId}/data_privacy/deletion_requests/{id}.

Lua path: app.integrations.beehiiv.get_data_deletion_request_oauth_scope_data_deletion_read
Full name: beehiiv.beehiiv_data_deletion_show

Parameter	Type	Required	Description
No parameters.

list_email_blasts_oauth_scope_posts_read Read

Execute official beehiiv API operation `emailBlasts_index`. Endpoint: GET /publications/{publicationId}/email_blasts.

Lua path: app.integrations.beehiiv.list_email_blasts_oauth_scope_posts_read
Full name: beehiiv.beehiiv_email_blasts_index

Parameter	Type	Required	Description
No parameters.

get_email_blast_oauth_scope_posts_read Read

Execute official beehiiv API operation `emailBlasts_show`. Endpoint: GET /publications/{publicationId}/email_blasts/{emailBlastId}.

Lua path: app.integrations.beehiiv.get_email_blast_oauth_scope_posts_read
Full name: beehiiv.beehiiv_email_blasts_show

Parameter	Type	Required	Description
No parameters.

get_publication_engagements_oauth_scope_publications_read Read

Execute official beehiiv API operation `engagements_index`. Endpoint: GET /publications/{publicationId}/engagements.

Lua path: app.integrations.beehiiv.get_publication_engagements_oauth_scope_publications_read
Full name: beehiiv.beehiiv_engagements_index

Parameter	Type	Required	Description
No parameters.

create_newsletter_list_subscription_beta_oauth_scope_newsletter_lists_write Write

Execute official beehiiv API operation `newsletterListSubscriptions_create`. Endpoint: POST /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions.

Lua path: app.integrations.beehiiv.create_newsletter_list_subscription_beta_oauth_scope_newsletter_lists_write
Full name: beehiiv.beehiiv_newsletter_list_subscriptions_create

Parameter	Type	Required	Description
No parameters.

list_newsletter_list_subscriptions_beta_oauth_scope_newsletter_lists_read Read

Execute official beehiiv API operation `newsletterListSubscriptions_index`. Endpoint: GET /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions.

Lua path: app.integrations.beehiiv.list_newsletter_list_subscriptions_beta_oauth_scope_newsletter_lists_read
Full name: beehiiv.beehiiv_newsletter_list_subscriptions_index

Parameter	Type	Required	Description
No parameters.

get_newsletter_list_subscription_beta_oauth_scope_newsletter_lists_read Read

Execute official beehiiv API operation `newsletterListSubscriptions_show`. Endpoint: GET /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}.

Lua path: app.integrations.beehiiv.get_newsletter_list_subscription_beta_oauth_scope_newsletter_lists_read
Full name: beehiiv.beehiiv_newsletter_list_subscriptions_show

Parameter	Type	Required	Description
No parameters.

update_newsletter_list_subscription_beta_oauth_scope_newsletter_lists_write Write

Execute official beehiiv API operation `newsletterListSubscriptions_update`. Endpoint: PATCH /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}.

Lua path: app.integrations.beehiiv.update_newsletter_list_subscription_beta_oauth_scope_newsletter_lists_write
Full name: beehiiv.beehiiv_newsletter_list_subscriptions_update

Parameter	Type	Required	Description
No parameters.

update_newsletter_list_subscription_by_subscription_id_beta_oauth_scope_newsletter_lists_write Write

Execute official beehiiv API operation `newsletterListSubscriptions_update_by_subscription_id`. Endpoint: PATCH /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}.

Lua path: app.integrations.beehiiv.update_newsletter_list_subscription_by_subscription_id_beta_oauth_scope_newsletter_lists_write
Full name: beehiiv.beehiiv_newsletter_list_subscriptions_update_by_subscription_id

Parameter	Type	Required	Description
No parameters.

list_newsletter_lists_beta_oauth_scope_newsletter_lists_read Read

Execute official beehiiv API operation `newsletterLists_index`. Endpoint: GET /publications/{publicationId}/newsletter_lists.

Lua path: app.integrations.beehiiv.list_newsletter_lists_beta_oauth_scope_newsletter_lists_read
Full name: beehiiv.beehiiv_newsletter_lists_index

Parameter	Type	Required	Description
No parameters.

get_newsletter_list_beta_oauth_scope_newsletter_lists_read Read

Execute official beehiiv API operation `newsletterLists_show`. Endpoint: GET /publications/{publicationId}/newsletter_lists/{newsletterListId}.

Lua path: app.integrations.beehiiv.get_newsletter_list_beta_oauth_scope_newsletter_lists_read
Full name: beehiiv.beehiiv_newsletter_lists_show

Parameter	Type	Required	Description
No parameters.

identify_user_oauth_scope_identify_read Read

Execute official beehiiv API operation `oauthUsers_identify`. Endpoint: GET /users/identify.

Lua path: app.integrations.beehiiv.identify_user_oauth_scope_identify_read
Full name: beehiiv.beehiiv_oauth_users_identify

Parameter	Type	Required	Description
No parameters.

list_polls_oauth_scope_polls_read Read

Execute official beehiiv API operation `polls_index`. Endpoint: GET /publications/{publicationId}/polls.

Lua path: app.integrations.beehiiv.list_polls_oauth_scope_polls_read
Full name: beehiiv.beehiiv_polls_index

Parameter	Type	Required	Description
No parameters.

list_poll_responses_oauth_scope_polls_read Read

Execute official beehiiv API operation `polls_list_responses`. Endpoint: GET /publications/{publicationId}/polls/{pollId}/responses.

Lua path: app.integrations.beehiiv.list_poll_responses_oauth_scope_polls_read
Full name: beehiiv.beehiiv_polls_list_responses

Parameter	Type	Required	Description
No parameters.

get_poll_oauth_scope_polls_read Read

Execute official beehiiv API operation `polls_show`. Endpoint: GET /publications/{publicationId}/polls/{pollId}.

Lua path: app.integrations.beehiiv.get_poll_oauth_scope_polls_read
Full name: beehiiv.beehiiv_polls_show

Parameter	Type	Required	Description
No parameters.

get_post_templates Read

Execute official beehiiv API operation `postTemplates_index`. Endpoint: GET /publications/{publicationId}/post_templates.

Lua path: app.integrations.beehiiv.get_post_templates
Full name: beehiiv.beehiiv_post_templates_index

Parameter	Type	Required	Description
No parameters.

get_aggregate_stats_oauth_scope_posts_read Read

Execute official beehiiv API operation `posts_aggregate_stats`. Endpoint: GET /publications/{publicationId}/posts/aggregate_stats.

Lua path: app.integrations.beehiiv.get_aggregate_stats_oauth_scope_posts_read
Full name: beehiiv.beehiiv_posts_aggregate_stats

Parameter	Type	Required	Description
No parameters.

create_post_oauth_scope_posts_write Write

Execute official beehiiv API operation `posts_create`. Endpoint: POST /publications/{publicationId}/posts.

Lua path: app.integrations.beehiiv.create_post_oauth_scope_posts_write
Full name: beehiiv.beehiiv_posts_create

Parameter	Type	Required	Description
No parameters.

delete_post_oauth_scope_posts_write Write

Execute official beehiiv API operation `posts_delete`. Endpoint: DELETE /publications/{publicationId}/posts/{postId}.

Lua path: app.integrations.beehiiv.delete_post_oauth_scope_posts_write
Full name: beehiiv.beehiiv_posts_delete

Parameter	Type	Required	Description
No parameters.

list_posts_oauth_scope_posts_read Read

Execute official beehiiv API operation `posts_index`. Endpoint: GET /publications/{publicationId}/posts.

Lua path: app.integrations.beehiiv.list_posts_oauth_scope_posts_read
Full name: beehiiv.beehiiv_posts_index

Parameter	Type	Required	Description
No parameters.

get_post_oauth_scope_posts_read Read

Execute official beehiiv API operation `posts_show`. Endpoint: GET /publications/{publicationId}/posts/{postId}.

Lua path: app.integrations.beehiiv.get_post_oauth_scope_posts_read
Full name: beehiiv.beehiiv_posts_show

Parameter	Type	Required	Description
No parameters.

update_post_oauth_scope_posts_write Write

Execute official beehiiv API operation `posts_update`. Endpoint: PATCH /publications/{publicationId}/posts/{postId}.

Lua path: app.integrations.beehiiv.update_post_oauth_scope_posts_write
Full name: beehiiv.beehiiv_posts_update

Parameter	Type	Required	Description
No parameters.

list_publications_oauth_scope_publications_read Read

Execute official beehiiv API operation `publications_index`. Endpoint: GET /publications.

Lua path: app.integrations.beehiiv.list_publications_oauth_scope_publications_read
Full name: beehiiv.beehiiv_publications_index

Parameter	Type	Required	Description
No parameters.

get_publication_oauth_scope_publications_read Read

Execute official beehiiv API operation `publications_show`. Endpoint: GET /publications/{publicationId}.

Lua path: app.integrations.beehiiv.get_publication_oauth_scope_publications_read
Full name: beehiiv.beehiiv_publications_show

Parameter	Type	Required	Description
No parameters.

get_referral_program_oauth_scope_referral_program_read Read

Execute official beehiiv API operation `referralProgram_show`. Endpoint: GET /publications/{publicationId}/referral_program.

Lua path: app.integrations.beehiiv.get_referral_program_oauth_scope_referral_program_read
Full name: beehiiv.beehiiv_referral_program_show

Parameter	Type	Required	Description
No parameters.

create_segment Write

Execute official beehiiv API operation `segments_create`. Endpoint: POST /publications/{publicationId}/segments.

Lua path: app.integrations.beehiiv.create_segment
Full name: beehiiv.beehiiv_segments_create

Parameter	Type	Required	Description
No parameters.

delete_segment_oauth_scope_segments_write Write

Execute official beehiiv API operation `segments_delete`. Endpoint: DELETE /publications/{publicationId}/segments/{segmentId}.

Lua path: app.integrations.beehiiv.delete_segment_oauth_scope_segments_write
Full name: beehiiv.beehiiv_segments_delete

Parameter	Type	Required	Description
No parameters.

list_segment_subscriber_ids_oauth_scope_segments_read Read

Execute official beehiiv API operation `segments_expand_results`. Endpoint: GET /publications/{publicationId}/segments/{segmentId}/results.

Lua path: app.integrations.beehiiv.list_segment_subscriber_ids_oauth_scope_segments_read
Full name: beehiiv.beehiiv_segments_expand_results

Parameter	Type	Required	Description
No parameters.

list_segments_oauth_scope_segments_read Read

Execute official beehiiv API operation `segments_index`. Endpoint: GET /publications/{publicationId}/segments.

Lua path: app.integrations.beehiiv.list_segments_oauth_scope_segments_read
Full name: beehiiv.beehiiv_segments_index

Parameter	Type	Required	Description
No parameters.

list_segment_subscribers_oauth_scope_segments_read Read

Execute official beehiiv API operation `segments_list_members`. Endpoint: GET /publications/{publicationId}/segments/{segmentId}/members.

Lua path: app.integrations.beehiiv.list_segment_subscribers_oauth_scope_segments_read
Full name: beehiiv.beehiiv_segments_list_members

Parameter	Type	Required	Description
No parameters.

recalculate_segment_oauth_scope_segments_write Write

Execute official beehiiv API operation `segments_recalculate`. Endpoint: PUT /publications/{publicationId}/segments/{segmentId}/recalculate.

Lua path: app.integrations.beehiiv.recalculate_segment_oauth_scope_segments_write
Full name: beehiiv.beehiiv_segments_recalculate

Parameter	Type	Required	Description
No parameters.

get_segment_oauth_scope_segments_read Read

Execute official beehiiv API operation `segments_show`. Endpoint: GET /publications/{publicationId}/segments/{segmentId}.

Lua path: app.integrations.beehiiv.get_segment_oauth_scope_segments_read
Full name: beehiiv.beehiiv_segments_show

Parameter	Type	Required	Description
No parameters.

add_subscription_tag_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `subscriptionTags_create`. Endpoint: POST /publications/{publicationId}/subscriptions/{subscriptionId}/tags.

Lua path: app.integrations.beehiiv.add_subscription_tag_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_subscription_tags_create

Parameter	Type	Required	Description
No parameters.

create_subscription_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `subscriptions_create`. Endpoint: POST /publications/{publicationId}/subscriptions.

Lua path: app.integrations.beehiiv.create_subscription_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_subscriptions_create

Parameter	Type	Required	Description
No parameters.

delete_subscription_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `subscriptions_delete`. Endpoint: DELETE /publications/{publicationId}/subscriptions/{subscriptionId}.

Lua path: app.integrations.beehiiv.delete_subscription_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_subscriptions_delete

Parameter	Type	Required	Description
No parameters.

get_subscription_by_email_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `subscriptions_get-by-email`. Endpoint: GET /publications/{publicationId}/subscriptions/by_email/{email}.

Lua path: app.integrations.beehiiv.get_subscription_by_email_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_subscriptions_get_by_email

Parameter	Type	Required	Description
No parameters.

get_subscription_by_id_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `subscriptions_get-by-id`. Endpoint: GET /publications/{publicationId}/subscriptions/{subscriptionId}.

Lua path: app.integrations.beehiiv.get_subscription_by_id_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_subscriptions_get_by_id

Parameter	Type	Required	Description
No parameters.

get_subscription_by_subscriber_id_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `subscriptions_get-by-subscriber-id`. Endpoint: GET /publications/{publicationId}/subscriptions/by_subscriber_id/{subscriberId}.

Lua path: app.integrations.beehiiv.get_subscription_by_subscriber_id_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_subscriptions_get_by_subscriber_id

Parameter	Type	Required	Description
No parameters.

get_subscription_jwt_token_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `subscriptions_get-jwt_token`. Endpoint: GET /publications/{publicationId}/subscriptions/{subscriptionId}/jwt_token.

Lua path: app.integrations.beehiiv.get_subscription_jwt_token_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_subscriptions_get_jwt_token

Parameter	Type	Required	Description
No parameters.

list_subscriptions_oauth_scope_subscriptions_read Read

Execute official beehiiv API operation `subscriptions_index`. Endpoint: GET /publications/{publicationId}/subscriptions.

Lua path: app.integrations.beehiiv.list_subscriptions_oauth_scope_subscriptions_read
Full name: beehiiv.beehiiv_subscriptions_index

Parameter	Type	Required	Description
No parameters.

update_subscription_by_id_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `subscriptions_patch`. Endpoint: PATCH /publications/{publicationId}/subscriptions/{subscriptionId}.

Lua path: app.integrations.beehiiv.update_subscription_by_id_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_subscriptions_patch

Parameter	Type	Required	Description
No parameters.

update_subscription_by_id_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `subscriptions_put`. Endpoint: PUT /publications/{publicationId}/subscriptions/{subscriptionId}.

Lua path: app.integrations.beehiiv.update_subscription_by_id_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_subscriptions_put

Parameter	Type	Required	Description
No parameters.

update_subscription_by_email_oauth_scope_subscriptions_write Write

Execute official beehiiv API operation `subscriptions_update-by-email`. Endpoint: PUT /publications/{publicationId}/subscriptions/by_email/{email}.

Lua path: app.integrations.beehiiv.update_subscription_by_email_oauth_scope_subscriptions_write
Full name: beehiiv.beehiiv_subscriptions_update_by_email

Parameter	Type	Required	Description
No parameters.

create_tier_oauth_scope_tiers_write Write

Execute official beehiiv API operation `tiers_create`. Endpoint: POST /publications/{publicationId}/tiers.

Lua path: app.integrations.beehiiv.create_tier_oauth_scope_tiers_write
Full name: beehiiv.beehiiv_tiers_create

Parameter	Type	Required	Description
No parameters.

list_tiers_oauth_scope_tiers_read Read

Execute official beehiiv API operation `tiers_index`. Endpoint: GET /publications/{publicationId}/tiers.

Lua path: app.integrations.beehiiv.list_tiers_oauth_scope_tiers_read
Full name: beehiiv.beehiiv_tiers_index

Parameter	Type	Required	Description
No parameters.

update_tier_oauth_scope_tiers_write Write

Execute official beehiiv API operation `tiers_patch`. Endpoint: PATCH /publications/{publicationId}/tiers/{tierId}.

Lua path: app.integrations.beehiiv.update_tier_oauth_scope_tiers_write
Full name: beehiiv.beehiiv_tiers_patch

Parameter	Type	Required	Description
No parameters.

update_tier_oauth_scope_tiers_write Write

Execute official beehiiv API operation `tiers_put`. Endpoint: PUT /publications/{publicationId}/tiers/{tierId}.

Lua path: app.integrations.beehiiv.update_tier_oauth_scope_tiers_write
Full name: beehiiv.beehiiv_tiers_put

Parameter	Type	Required	Description
No parameters.

get_tier_oauth_scope_tiers_read Read

Execute official beehiiv API operation `tiers_show`. Endpoint: GET /publications/{publicationId}/tiers/{tierId}.

Lua path: app.integrations.beehiiv.get_tier_oauth_scope_tiers_read
Full name: beehiiv.beehiiv_tiers_show

Parameter	Type	Required	Description
No parameters.

create_webhook_oauth_scope_webhooks_write Write

Execute official beehiiv API operation `webhooks_create`. Endpoint: POST /publications/{publicationId}/webhooks.

Lua path: app.integrations.beehiiv.create_webhook_oauth_scope_webhooks_write
Full name: beehiiv.beehiiv_webhooks_create

Parameter	Type	Required	Description
No parameters.

delete_webhook_oauth_scope_webhooks_write Write

Execute official beehiiv API operation `webhooks_delete`. Endpoint: DELETE /publications/{publicationId}/webhooks/{endpointId}.

Lua path: app.integrations.beehiiv.delete_webhook_oauth_scope_webhooks_write
Full name: beehiiv.beehiiv_webhooks_delete

Parameter	Type	Required	Description
No parameters.

list_webhooks_oauth_scope_webhooks_read Read

Execute official beehiiv API operation `webhooks_index`. Endpoint: GET /publications/{publicationId}/webhooks.

Lua path: app.integrations.beehiiv.list_webhooks_oauth_scope_webhooks_read
Full name: beehiiv.beehiiv_webhooks_index

Parameter	Type	Required	Description
No parameters.

get_webhook_oauth_scope_webhooks_read Read

Execute official beehiiv API operation `webhooks_show`. Endpoint: GET /publications/{publicationId}/webhooks/{endpointId}.

Lua path: app.integrations.beehiiv.get_webhook_oauth_scope_webhooks_read
Full name: beehiiv.beehiiv_webhooks_show

Parameter	Type	Required	Description
No parameters.

test_webhook_oauth_scope_webhooks_read Read

Execute official beehiiv API operation `webhooks_test`. Endpoint: GET /publications/{publicationId}/webhooks/{endpointId}/tests.

Lua path: app.integrations.beehiiv.test_webhook_oauth_scope_webhooks_read
Full name: beehiiv.beehiiv_webhooks_test

Parameter	Type	Required	Description
No parameters.

update_webhook_oauth_scope_webhooks_write Write

Execute official beehiiv API operation `webhooks_update`. Endpoint: PATCH /publications/{publicationId}/webhooks/{endpointId}.

Lua path: app.integrations.beehiiv.update_webhook_oauth_scope_webhooks_write
Full name: beehiiv.beehiiv_webhooks_update

Parameter	Type	Required	Description
No parameters.

identify_workspace_oauth_scope_identify_read Read

Execute official beehiiv API operation `workspaces_identify`. Endpoint: GET /workspaces/identify.

Lua path: app.integrations.beehiiv.identify_workspace_oauth_scope_identify_read
Full name: beehiiv.beehiiv_workspaces_identify

Parameter	Type	Required	Description
No parameters.

get_publications_by_subscription_email_oauth_scope_publications_read Read

Execute official beehiiv API operation `workspaces_publications-by-subscription-email`. Endpoint: GET /workspaces/publications/by_subscription_email/{email}.

Lua path: app.integrations.beehiiv.get_publications_by_subscription_email_oauth_scope_publications_read
Full name: beehiiv.beehiiv_workspaces_publications_by_subscription_email

Parameter	Type	Required	Description
No parameters.