How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

beehiiv Webhooks API

The Webhooks API from beehiiv — 0 operation(s) for webhooks.

beehiiv Webhooks API is one of 30 APIs that beehiiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an AsyncAPI specification.

This API exposes 5 operations across 2 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.beehiiv.com/v2.

5 operations 2 paths 32 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.beehiiv.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

beehiiv Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 5
POST
/publications/{publicationId}/webhooks
Create a webhook OAuth Scope: webhooks:write
create 2 params body → 200400401404429500
GET
/publications/{publicationId}/webhooks
List webhooks OAuth Scope: webhooks:read
index 3 params → 200400401404429500
GET
/publications/{publicationId}/webhooks/{endpointId}
Get webhook OAuth Scope: webhooks:read
show 3 params → 200400401404422429500
PATCH
/publications/{publicationId}/webhooks/{endpointId}
Update webhook OAuth Scope: webhooks:write
update 3 params body → 200400401404429500
DELETE
/publications/{publicationId}/webhooks/{endpointId}
Delete a webhook OAuth Scope: webhooks:write
delete 3 params → 204400401404429500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are type_post_PostData (22 properties), type_podcasts_PodcastShowData (17 properties), type_podcasts_PodcastEpisodeData (17 properties), type_subscription_SubscriptionData (15 properties). Each schema is shown below with its type and property counts.

type_webhooks_WebhooksDeleteResponse
object
1 property
type_ids_EndpointId
string
The prefixed ID of the endpoint.
type_webhooks_WebhookEventType
string
type_webhooks_WebhookResponse
object
1 property 1 required
type_ids_PublicationId
string
The prefixed ID of the publication.
type__Error
object
The top level error response.
3 properties 3 required
type_webhooks_Webhook
object
6 properties 6 required
type__ErrorDetail
object
2 properties 2 required
type_webhooks_IndexWebhooksResponse
object
1 property 1 required
type_subscription_SubscriptionData
object
15 properties
type_newsletter_list_subscription_NewsletterListSubscriptionStatus
string
The status of the newsletter list subscription.
type_subscription_Subscription
object
4 properties
type_subscription_SubscriptionDataStatus
string
The status of the subscription.
type_podcasts_PodcastShowType
string
The type of the podcast. episodic - Episodes can be consumed in any order. serial - Episodes are intended to be consumed in order.
type_survey_SurveyResponse
object
4 properties
type_newsletter_list_subscription_NewsletterListSubscriptionData
object
9 properties 7 required
type_post_PostData
object
22 properties 17 required
type_survey_SurveyResponseQuestion
object
3 properties
type_podcasts_PodcastShowStatus
string
The status of the podcast. draft - No episodes have been published. live - Published and active. archived - The podcast is no longer active.
type_podcasts_PodcastPrivateFeed
object
4 properties
type_subscription_CustomFieldKind
string
The type of the custom field.
type_podcasts_PodcastEpisodeStatus
string
The status of the episode. draft - Not yet published. scheduled - Scheduled for future publication. published - Available via web and RSS. archived - No longer…
type_podcasts_PodcastPrivateFeedData
object
8 properties 5 required
type_newsletter_list_subscription_NewsletterListSubscription
object
4 properties
type_podcasts_PodcastEpisode
object
4 properties
type_survey_SurveyResponseAnswer
object
5 properties
type_post_PostStatus
string
The status of the post. draft - not been scheduled. confirmed - The post will be active after the scheduledat. archived - The post is no longer active.
type_podcasts_PodcastEpisodeData
object
17 properties 11 required
type_post_Post
object
4 properties
type_survey_SurveyResponseData
object
6 properties
type_podcasts_PodcastShowData
object
17 properties 14 required
type_subscription_CustomFieldValue
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-webhooks-api-openapi.yml Raw ↑

Other APIs beehiiv publishes across the network.

beehiiv Authorizations API
beehiiv Tokens API
beehiiv Ad Network Offers API
beehiiv Ad Network Reports API
beehiiv Advertisement Opportunities API
beehiiv Authors API
beehiiv Automation Journeys API
beehiiv Automations API
beehiiv Bulk Subscription Updates API
beehiiv Bulk Subscriptions API
beehiiv Complimentary Access API
beehiiv Condition Sets API
Where this information came from

This is an independent, third-party profile of beehiiv Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.