productivity
beehiiv MCP, CLI, and Lua Integration for AI Agents
beehiiv integration docs for AI agents: MCP gateway setup, beehiiv CLI commands, Lua API reference, credentials, and function schemas.beehiiv for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
beehiiv.beehiiv_advertisement_opportunities_index | Read read | 0 | Execute official beehiiv API operation `advertisementOpportunities_index`. Endpoint: GET /publications/{publicationId}/advertisement_opportunities. |
beehiiv.beehiiv_authors_index | Read read | 0 | Execute official beehiiv API operation `authors_index`. Endpoint: GET /publications/{publicationId}/authors. |
beehiiv.beehiiv_authors_show | Read read | 0 | Execute official beehiiv API operation `authors_show`. Endpoint: GET /publications/{publicationId}/authors/{authorId}. |
beehiiv.beehiiv_automation_journeys_create | Write write | 0 | Execute official beehiiv API operation `automationJourneys_create`. Endpoint: POST /publications/{publicationId}/automations/{automationId}/journeys. |
beehiiv.beehiiv_automation_journeys_index | Read read | 0 | Execute official beehiiv API operation `automationJourneys_index`. Endpoint: GET /publications/{publicationId}/automations/{automationId}/journeys. |
beehiiv.beehiiv_automation_journeys_show | Read read | 0 | Execute official beehiiv API operation `automationJourneys_show`. Endpoint: GET /publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}. |
beehiiv.beehiiv_automations_index | Read read | 0 | Execute official beehiiv API operation `automations_index`. Endpoint: GET /publications/{publicationId}/automations. |
beehiiv.beehiiv_automations_list_emails | Read read | 0 | Execute official beehiiv API operation `automations_listEmails`. Endpoint: GET /publications/{publicationId}/automations/{automationId}/emails. |
beehiiv.beehiiv_automations_show | Read read | 0 | Execute official beehiiv API operation `automations_show`. Endpoint: GET /publications/{publicationId}/automations/{automationId}. |
beehiiv.beehiiv_bulk_subscription_updates_index | Read read | 0 | Execute official beehiiv API operation `bulkSubscriptionUpdates_index`. Endpoint: GET /publications/{publicationId}/bulk_subscription_updates. |
beehiiv.beehiiv_bulk_subscription_updates_patch | Write write | 0 | Execute official beehiiv API operation `bulkSubscriptionUpdates_patch`. Endpoint: PATCH /publications/{publicationId}/subscriptions/bulk_actions. |
beehiiv.beehiiv_bulk_subscription_updates_patch_status | Write write | 0 | Execute official beehiiv API operation `bulkSubscriptionUpdates_patch-status`. Endpoint: PATCH /publications/{publicationId}/subscriptions. |
beehiiv.beehiiv_bulk_subscription_updates_put | Write write | 0 | Execute official beehiiv API operation `bulkSubscriptionUpdates_put`. Endpoint: PUT /publications/{publicationId}/subscriptions/bulk_actions. |
beehiiv.beehiiv_bulk_subscription_updates_put_status | Write write | 0 | Execute official beehiiv API operation `bulkSubscriptionUpdates_put-status`. Endpoint: PUT /publications/{publicationId}/subscriptions. |
beehiiv.beehiiv_bulk_subscription_updates_show | Read read | 0 | Execute official beehiiv API operation `bulkSubscriptionUpdates_show`. Endpoint: GET /publications/{publicationId}/bulk_subscription_updates/{id}. |
beehiiv.beehiiv_bulk_subscriptions_create | Write write | 0 | Execute official beehiiv API operation `bulkSubscriptions_create`. Endpoint: POST /publications/{publicationId}/bulk_subscriptions. |
beehiiv.beehiiv_condition_sets_index | Read read | 0 | Execute official beehiiv API operation `conditionSets_index`. Endpoint: GET /publications/{publicationId}/condition_sets. |
beehiiv.beehiiv_condition_sets_show | Read read | 0 | Execute official beehiiv API operation `conditionSets_show`. Endpoint: GET /publications/{publicationId}/condition_sets/{conditionSetId}. |
beehiiv.beehiiv_custom_fields_create | Write write | 0 | Execute official beehiiv API operation `customFields_create`. Endpoint: POST /publications/{publicationId}/custom_fields. |
beehiiv.beehiiv_custom_fields_delete | Write write | 0 | Execute official beehiiv API operation `customFields_delete`. Endpoint: DELETE /publications/{publicationId}/custom_fields/{id}. |
beehiiv.beehiiv_custom_fields_index | Read read | 0 | Execute official beehiiv API operation `customFields_index`. Endpoint: GET /publications/{publicationId}/custom_fields. |
beehiiv.beehiiv_custom_fields_patch | Write write | 0 | Execute official beehiiv API operation `customFields_patch`. Endpoint: PATCH /publications/{publicationId}/custom_fields/{id}. |
beehiiv.beehiiv_custom_fields_put | Write write | 0 | Execute official beehiiv API operation `customFields_put`. Endpoint: PUT /publications/{publicationId}/custom_fields/{id}. |
beehiiv.beehiiv_custom_fields_show | Read read | 0 | Execute official beehiiv API operation `customFields_show`. Endpoint: GET /publications/{publicationId}/custom_fields/{id}. |
beehiiv.beehiiv_data_deletion_create | Write write | 0 | Execute official beehiiv API operation `dataDeletion_create`. Endpoint: POST /publications/{publicationId}/data_privacy/deletion_requests. |
beehiiv.beehiiv_data_deletion_index | Read read | 0 | Execute official beehiiv API operation `dataDeletion_index`. Endpoint: GET /publications/{publicationId}/data_privacy/deletion_requests. |
beehiiv.beehiiv_data_deletion_show | Read read | 0 | Execute official beehiiv API operation `dataDeletion_show`. Endpoint: GET /publications/{publicationId}/data_privacy/deletion_requests/{id}. |
beehiiv.beehiiv_email_blasts_index | Read read | 0 | Execute official beehiiv API operation `emailBlasts_index`. Endpoint: GET /publications/{publicationId}/email_blasts. |
beehiiv.beehiiv_email_blasts_show | Read read | 0 | Execute official beehiiv API operation `emailBlasts_show`. Endpoint: GET /publications/{publicationId}/email_blasts/{emailBlastId}. |
beehiiv.beehiiv_engagements_index | Read read | 0 | Execute official beehiiv API operation `engagements_index`. Endpoint: GET /publications/{publicationId}/engagements. |
beehiiv.beehiiv_newsletter_list_subscriptions_create | Write write | 0 | Execute official beehiiv API operation `newsletterListSubscriptions_create`. Endpoint: POST /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions. |
beehiiv.beehiiv_newsletter_list_subscriptions_index | Read read | 0 | Execute official beehiiv API operation `newsletterListSubscriptions_index`. Endpoint: GET /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions. |
beehiiv.beehiiv_newsletter_list_subscriptions_show | Read read | 0 | Execute official beehiiv API operation `newsletterListSubscriptions_show`. Endpoint: GET /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}. |
beehiiv.beehiiv_newsletter_list_subscriptions_update | Write write | 0 | Execute official beehiiv API operation `newsletterListSubscriptions_update`. Endpoint: PATCH /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}. |
beehiiv.beehiiv_newsletter_list_subscriptions_update_by_subscription_id | Write write | 0 | Execute official beehiiv API operation `newsletterListSubscriptions_update_by_subscription_id`. Endpoint: PATCH /publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}. |
beehiiv.beehiiv_newsletter_lists_index | Read read | 0 | Execute official beehiiv API operation `newsletterLists_index`. Endpoint: GET /publications/{publicationId}/newsletter_lists. |
beehiiv.beehiiv_newsletter_lists_show | Read read | 0 | Execute official beehiiv API operation `newsletterLists_show`. Endpoint: GET /publications/{publicationId}/newsletter_lists/{newsletterListId}. |
beehiiv.beehiiv_oauth_users_identify | Read read | 0 | Execute official beehiiv API operation `oauthUsers_identify`. Endpoint: GET /users/identify. |
beehiiv.beehiiv_polls_index | Read read | 0 | Execute official beehiiv API operation `polls_index`. Endpoint: GET /publications/{publicationId}/polls. |
beehiiv.beehiiv_polls_list_responses | Read read | 0 | Execute official beehiiv API operation `polls_list_responses`. Endpoint: GET /publications/{publicationId}/polls/{pollId}/responses. |
beehiiv.beehiiv_polls_show | Read read | 0 | Execute official beehiiv API operation `polls_show`. Endpoint: GET /publications/{publicationId}/polls/{pollId}. |
beehiiv.beehiiv_post_templates_index | Read read | 0 | Execute official beehiiv API operation `postTemplates_index`. Endpoint: GET /publications/{publicationId}/post_templates. |
beehiiv.beehiiv_posts_aggregate_stats | Read read | 0 | Execute official beehiiv API operation `posts_aggregate_stats`. Endpoint: GET /publications/{publicationId}/posts/aggregate_stats. |
beehiiv.beehiiv_posts_create | Write write | 0 | Execute official beehiiv API operation `posts_create`. Endpoint: POST /publications/{publicationId}/posts. |
beehiiv.beehiiv_posts_delete | Write write | 0 | Execute official beehiiv API operation `posts_delete`. Endpoint: DELETE /publications/{publicationId}/posts/{postId}. |
beehiiv.beehiiv_posts_index | Read read | 0 | Execute official beehiiv API operation `posts_index`. Endpoint: GET /publications/{publicationId}/posts. |
beehiiv.beehiiv_posts_show | Read read | 0 | Execute official beehiiv API operation `posts_show`. Endpoint: GET /publications/{publicationId}/posts/{postId}. |
beehiiv.beehiiv_posts_update | Write write | 0 | Execute official beehiiv API operation `posts_update`. Endpoint: PATCH /publications/{publicationId}/posts/{postId}. |
beehiiv.beehiiv_publications_index | Read read | 0 | Execute official beehiiv API operation `publications_index`. Endpoint: GET /publications. |
beehiiv.beehiiv_publications_show | Read read | 0 | Execute official beehiiv API operation `publications_show`. Endpoint: GET /publications/{publicationId}. |
beehiiv.beehiiv_referral_program_show | Read read | 0 | Execute official beehiiv API operation `referralProgram_show`. Endpoint: GET /publications/{publicationId}/referral_program. |
beehiiv.beehiiv_segments_create | Write write | 0 | Execute official beehiiv API operation `segments_create`. Endpoint: POST /publications/{publicationId}/segments. |
beehiiv.beehiiv_segments_delete | Write write | 0 | Execute official beehiiv API operation `segments_delete`. Endpoint: DELETE /publications/{publicationId}/segments/{segmentId}. |
beehiiv.beehiiv_segments_expand_results | Read read | 0 | Execute official beehiiv API operation `segments_expand_results`. Endpoint: GET /publications/{publicationId}/segments/{segmentId}/results. |
beehiiv.beehiiv_segments_index | Read read | 0 | Execute official beehiiv API operation `segments_index`. Endpoint: GET /publications/{publicationId}/segments. |
beehiiv.beehiiv_segments_list_members | Read read | 0 | Execute official beehiiv API operation `segments_list_members`. Endpoint: GET /publications/{publicationId}/segments/{segmentId}/members. |
beehiiv.beehiiv_segments_recalculate | Write write | 0 | Execute official beehiiv API operation `segments_recalculate`. Endpoint: PUT /publications/{publicationId}/segments/{segmentId}/recalculate. |
beehiiv.beehiiv_segments_show | Read read | 0 | Execute official beehiiv API operation `segments_show`. Endpoint: GET /publications/{publicationId}/segments/{segmentId}. |
beehiiv.beehiiv_subscription_tags_create | Write write | 0 | Execute official beehiiv API operation `subscriptionTags_create`. Endpoint: POST /publications/{publicationId}/subscriptions/{subscriptionId}/tags. |
beehiiv.beehiiv_subscriptions_create | Write write | 0 | Execute official beehiiv API operation `subscriptions_create`. Endpoint: POST /publications/{publicationId}/subscriptions. |
beehiiv.beehiiv_subscriptions_delete | Write write | 0 | Execute official beehiiv API operation `subscriptions_delete`. Endpoint: DELETE /publications/{publicationId}/subscriptions/{subscriptionId}. |
beehiiv.beehiiv_subscriptions_get_by_email | Read read | 0 | Execute official beehiiv API operation `subscriptions_get-by-email`. Endpoint: GET /publications/{publicationId}/subscriptions/by_email/{email}. |
beehiiv.beehiiv_subscriptions_get_by_id | Read read | 0 | Execute official beehiiv API operation `subscriptions_get-by-id`. Endpoint: GET /publications/{publicationId}/subscriptions/{subscriptionId}. |
beehiiv.beehiiv_subscriptions_get_by_subscriber_id | Read read | 0 | Execute official beehiiv API operation `subscriptions_get-by-subscriber-id`. Endpoint: GET /publications/{publicationId}/subscriptions/by_subscriber_id/{subscriberId}. |
beehiiv.beehiiv_subscriptions_get_jwt_token | Read read | 0 | Execute official beehiiv API operation `subscriptions_get-jwt_token`. Endpoint: GET /publications/{publicationId}/subscriptions/{subscriptionId}/jwt_token. |
beehiiv.beehiiv_subscriptions_index | Read read | 0 | Execute official beehiiv API operation `subscriptions_index`. Endpoint: GET /publications/{publicationId}/subscriptions. |
beehiiv.beehiiv_subscriptions_patch | Write write | 0 | Execute official beehiiv API operation `subscriptions_patch`. Endpoint: PATCH /publications/{publicationId}/subscriptions/{subscriptionId}. |
beehiiv.beehiiv_subscriptions_put | Write write | 0 | Execute official beehiiv API operation `subscriptions_put`. Endpoint: PUT /publications/{publicationId}/subscriptions/{subscriptionId}. |
beehiiv.beehiiv_subscriptions_update_by_email | Write write | 0 | Execute official beehiiv API operation `subscriptions_update-by-email`. Endpoint: PUT /publications/{publicationId}/subscriptions/by_email/{email}. |
beehiiv.beehiiv_tiers_create | Write write | 0 | Execute official beehiiv API operation `tiers_create`. Endpoint: POST /publications/{publicationId}/tiers. |
beehiiv.beehiiv_tiers_index | Read read | 0 | Execute official beehiiv API operation `tiers_index`. Endpoint: GET /publications/{publicationId}/tiers. |
beehiiv.beehiiv_tiers_patch | Write write | 0 | Execute official beehiiv API operation `tiers_patch`. Endpoint: PATCH /publications/{publicationId}/tiers/{tierId}. |
beehiiv.beehiiv_tiers_put | Write write | 0 | Execute official beehiiv API operation `tiers_put`. Endpoint: PUT /publications/{publicationId}/tiers/{tierId}. |
beehiiv.beehiiv_tiers_show | Read read | 0 | Execute official beehiiv API operation `tiers_show`. Endpoint: GET /publications/{publicationId}/tiers/{tierId}. |
beehiiv.beehiiv_webhooks_create | Write write | 0 | Execute official beehiiv API operation `webhooks_create`. Endpoint: POST /publications/{publicationId}/webhooks. |
beehiiv.beehiiv_webhooks_delete | Write write | 0 | Execute official beehiiv API operation `webhooks_delete`. Endpoint: DELETE /publications/{publicationId}/webhooks/{endpointId}. |
beehiiv.beehiiv_webhooks_index | Read read | 0 | Execute official beehiiv API operation `webhooks_index`. Endpoint: GET /publications/{publicationId}/webhooks. |
beehiiv.beehiiv_webhooks_show | Read read | 0 | Execute official beehiiv API operation `webhooks_show`. Endpoint: GET /publications/{publicationId}/webhooks/{endpointId}. |
beehiiv.beehiiv_webhooks_test | Read read | 0 | Execute official beehiiv API operation `webhooks_test`. Endpoint: GET /publications/{publicationId}/webhooks/{endpointId}/tests. |
beehiiv.beehiiv_webhooks_update | Write write | 0 | Execute official beehiiv API operation `webhooks_update`. Endpoint: PATCH /publications/{publicationId}/webhooks/{endpointId}. |
beehiiv.beehiiv_workspaces_identify | Read read | 0 | Execute official beehiiv API operation `workspaces_identify`. Endpoint: GET /workspaces/identify. |
beehiiv.beehiiv_workspaces_publications_by_subscription_email | Read read | 0 | Execute official beehiiv API operation `workspaces_publications-by-subscription-email`. Endpoint: GET /workspaces/publications/by_subscription_email/{email}. |