Skip to main content
POST
Create a webhook subscription
Required scope
  • read:self — Access your own user profile information, including basic account details and settings.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Body

application/json
url
string<uri>
required

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

events
enum<string>[]
required

One or more platform events this subscription delivers

Minimum array length: 1

The platform event the webhook subscription delivers

Available options:
checkout_link.payment.pending,
checkout_link.payment.succeeded,
checkout_link.payment.failed,
checkout_link.subscription.activated,
checkout_link.subscription.deactivated,
checkout_link.subscription.cancel_at_period_end_changed,
checkout_link.refund.created,
checkout_link.dispute.flagged,
checkout_link.dispute.created,
checkout_link.installment.paid,
checkout_link.installment.failed,
checkout_link.plan.completed,
payout.paid,
follow.new,
message.read,
message.received,
purchase.new,
subscription.new,
subscription.renewed,
subscription.cancelled,
subscription.expired,
tip.new,
creator.payment.succeeded,
creator.subscription.activated,
creator.subscription.deactivated,
creator.subscription.cancel_at_period_end_changed,
creator.post.liked,
creator.post.commented,
creator.message.reaction,
creator.message.deleted,
creator.refund.created,
creator.dispute.flagged,
creator.dispute.created,
creator.fan.status_changed,
creator.follow.created,
creator.message.received,
creator.message.sent,
creator.message.read

Response

Webhook subscription created successfully

id
string<uuid>
required

ID of the created webhook subscription

signingSecret
string
required

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