latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Create a webhook subscription

Subscribe a public HTTPS URL to one or more platform events. Every requested event is delivered to the same URL and signed with the single signingSecret returned in the response — store it, as it is only returned at creation time. The token must hold the OAuth scope each requested event needs: read:creator for subscription.new, subscription.renewed, subscription.cancelled, subscription.expired, follow.new, purchase.new, tip.new, the checkout_link.* and payout.paid events, and the creator.payment.succeeded, creator.subscription.*, creator.refund.created, and creator.dispute.* events; read:post for creator.post.liked and creator.post.commented; read:chat for message.received, message.read, creator.message.received, creator.message.sent, creator.message.read, creator.message.reaction, and creator.message.deleted.

post/webhooks/subscriptions

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Request body

urlstring uri required

Public HTTPS URL the event payloads are delivered to (no redirects, no localhost)

eventsstring[] required

One or more platform events this subscription delivers

Response

Webhook subscription created successfully

idstring uuid required

ID of the created webhook subscription

signingSecretstring required

HMAC signing secret for verifying delivery signatures. Returned only on creation — store it securely now.