beehiiv Developer Documentation

Create a new webhook for a given publication.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

This endpoint expects an object.

urlstringRequiredformat: "uri"

The webhook URL to send events to.

event_typeslist of enumsRequired

The types of events the webhook will receive.

descriptionstringOptional

A description of the webhook.

Webhook created

dataobject

1	import requests
2
3	url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/webhooks"
4
5	payload = {
6	"url": "https://example.com/webhook",
7	"event_types": ["post.sent"]
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"data": {
3	"id": "ep_0ca1a8505a64924059c391744d0",
4	"url": "https://example.com/webhook",
5	"created": 1666800076,
6	"updated": 1666800076,
7	"event_types": [
8	"post.sent",
9	"subscription.confirmed"
10	],
11	"description": "A webhook to receive new posts data and new subscription confirmations."
12	}
13	}

Create a webhook OAuth Scope: webhooks:write