Skip to main content
POST
Send a test webhook event
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
event
enum<string>
required

The platform event to deliver. Deprecated flat events cannot be tested.

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,
payout.failed,
creator.payment.succeeded,
creator.subscription.activated,
creator.subscription.renewed,
creator.subscription.deactivated,
creator.subscription.cancel_at_period_end_changed,
creator.experience_subscription.deactivated,
creator.experience_subscription.activated,
creator.post.liked,
creator.post.commented,
creator.message.reaction,
creator.message.deleted,
creator.refund.created,
creator.dispute.flagged,
creator.dispute.created,
creator.reward.created,
creator.reward.reversed,
creator.fan.status_changed,
creator.fan.presence_changed,
creator.follow.created,
creator.message.received,
creator.message.sent,
creator.message.mass_sent,
creator.message.read,
creator.message.read_by_fan

Response

Test event accepted for delivery

id
string<uuid>
required

ID of the delivered test event. Matches the id in the delivered envelope, so you can correlate this response with what arrives at your endpoint.

event
string
required

The platform event that was delivered