beehiiv Developer Documentation

1	{
2	"data": {
3	"id": "pod_feed_00000000-0000-0000-0000-000000000000",
4	"url": "https://rss.beehiiv.com/podcasts/00000000-0000-0000-0000-000000000000/private/token.xml",
5	"created": 1666800076,
6	"subscription": {
7	"created": 1666800076,
8	"email": "[email protected]",
9	"id": "sub_00000000-0000-0000-0000-000000000000",
10	"referral_code": "ABC123",
11	"referring_site": "https://www.blog.com",
12	"status": "active",
13	"subscription_tier": "premium",
14	"subscription_premium_tier_names": [
15	"Premium",
16	"Pro"
17	],
18	"stripe_customer_id": "cus_00000000000000",
19	"utm_campaign": "Q1 Campaign",
20	"utm_channel": "website",
21	"utm_medium": "organic",
22	"utm_source": "Twitter",
23	"custom_fields": [
24	{
25	"name": "Newsletter Preference",
26	"kind": "boolean",
27	"value": "true"
28	},
29	{
30	"name": "Company",
31	"kind": "string",
32	"value": "Acme Corp"
33	}
34	],
35	"tags": [
36	"VIP",
37	"Newsletter"
38	]
39	},
40	"show": {
41	"id": "pod_00000000-0000-0000-0000-000000000000",
42	"created": 1666800076,
43	"slug": "morning_brief",
44	"description": "Daily market coverage",
45	"categories": [
46	"Business"
47	],
48	"artwork_url": "https://example.com/show-artwork.png",
49	"status": "live",
50	"language": "en",
51	"title": "Morning Brief",
52	"author": "Jane Doe",
53	"type": "episodic",
54	"imported": false,
55	"copyright": "Morning Brief",
56	"explicit": false,
57	"publishing_frequency": 1,
58	"website_url": "https://example.com",
59	"platform_links": {
60	"apple": "https://podcasts.apple.com/example"
61	}
62	},
63	"activated": 1666800076
64	},
65	"event_timestamp": 1666800076,
66	"event_type": "podcasts.private_feed.access_revoked",
67	"uid": "evt_00000000-0000-0000-0000-000000000000"
68	}

Payload

The payload of this webhook request is an object.

dataobjectOptional

event_timestampintegerOptional

The date the event was created. Measured in seconds since the Unix epoch.

event_typestringOptional

The event type.

uidstringOptional

The prefixed event ID, unique to each webhook event.

Response

200

any

Return a 200 status to indicate that the data was received successfully.