beehiiv Developer Documentation

1 curl -X PATCH https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/webhooks/ep_0000000000000000000000000000 \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "event_types": [ 6 "post.sent", 7 "subscription.confirmed" 8 ], 9 "description": "A webhook to receive new posts data and new subscription confirmations." 10 }'

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 }

Update a webhook subscription for a publication.

Authentication

AuthorizationBearer

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

Path parameters

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

The prefixed ID of the publication object

endpointIdstringRequiredformat: "^(ep_.+)$"

The prefixed ID of the webhook object

Request

This endpoint expects an object.

event_typeslist of enumsOptional

The types of events the webhook will receive.

descriptionstringOptional

A description of the webhook.

Response

dataobject

Update webhook

Authentication

Path parameters

Request

Response

Errors