> ## Documentation Index > Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Send a test webhook event > Deliver a synthetic event of the given type to your own subscriptions, so you can build and verify a handler without waiting for a real one to occur. The delivery is indistinguishable from a genuine event: same envelope, same signature, same retry behaviour. Only the values inside `data` are synthetic, and identifiers are prefixed with `TEST-`. You must already have an active subscription for the requested event; this endpoint delivers to the URLs you registered and cannot be pointed at any other. Every subscription covering the event receives the delivery, exactly as a real event would. The token must hold the same scope subscribing to that event requires. **Required scope** * `read:self` — Access your own user profile information, including basic account details and settings. ## OpenAPI ````yaml /openapi-v1.json post /v1/webhooks/test openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: - url: https://api.fanvue.com security: [] paths: /v1/webhooks/test: post: summary: Send a test webhook event description: >- Deliver a synthetic event of the given type to your own subscriptions, so you can build and verify a handler without waiting for a real one to occur. The delivery is indistinguishable from a genuine event: same envelope, same signature, same retry behaviour. Only the values inside `data` are synthetic, and identifiers are prefixed with `TEST-`. You must already have an active subscription for the requested event; this endpoint delivers to the URLs you registered and cannot be pointed at any other. Every subscription covering the event receives the delivery, exactly as a real event would. The token must hold the same scope subscribing to that event requires. operationId: sendTestWebhook parameters: - $ref: '#/components/parameters/ApiVersionHeader' requestBody: content: application/json: schema: type: object properties: event: type: string enum: - 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 description: >- The platform event to deliver. Deprecated flat events cannot be tested. required: - event responses: '202': description: Test event accepted for delivery content: application/json: schema: type: object properties: id: type: string format: uuid description: >- 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: type: string description: The platform event that was delivered required: - id - event example: id: 4f6c1f8a-2b9d-4c3e-9f1a-7d8e5c2b4a10 event: checkout_link.payment.succeeded '400': description: Bad Request - API version not supported OR validation failed content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ValidationError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '410': $ref: '#/components/responses/SunsetVersionResponse' '429': $ref: '#/components/responses/RateLimitResponse' security: - BearerAuth: - read:self components: parameters: ApiVersionHeader: name: X-Fanvue-API-Version in: header required: true schema: type: string default: '2025-06-26' example: '2025-06-26' description: API version to use for the request schemas: UnsupportedVersionError: type: object properties: error: type: string message: type: string required: - error - message description: API version not supported ValidationError: type: object properties: errors: type: array items: type: string required: - errors description: Request validation failed responses: UnauthorizedResponse: description: Unauthorized Response content: application/json: schema: type: object properties: error: type: string required: - error NotFoundResponse: description: Not Found Response content: application/json: schema: type: object properties: message: type: string required: - message SunsetVersionResponse: description: API version no longer supported (sunset) content: application/json: schema: type: object properties: error: type: string message: type: string nextVersion: type: string required: - error - message RateLimitResponse: description: Too many requests - rate limit exceeded headers: Retry-After: description: Number of seconds to wait before retrying the request schema: type: integer X-RateLimit-Limit: description: The maximum number of requests allowed in the current window schema: type: integer X-RateLimit-Remaining: description: The number of requests remaining in the current window schema: type: integer X-RateLimit-Reset: description: The Unix timestamp (seconds) when the rate limit window resets schema: type: integer content: application/json: schema: type: object properties: error: type: string required: - error securitySchemes: BearerAuth: type: oauth2 description: >- 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. flows: authorizationCode: authorizationUrl: https://auth.fanvue.com/oauth2/auth tokenUrl: https://auth.fanvue.com/oauth2/token refreshUrl: https://auth.fanvue.com/oauth2/token scopes: read:self: >- Access your own user profile information, including basic account details and settings. read:chat: >- Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history. write:chat: >- Create new chats and send messages. This scope is required for any chat-related actions that modify data. read:experience: >- Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content. write:experience: >- Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change. read:fan: Access fan-related data and information within the platform. read:post: Read posts, including post details, comments, likes, and tips. write:post: Create, edit, and manage posts and content on behalf of users. read:media: Access media files, images, videos, and other content assets. write:media: >- Upload, modify, and manage media files and content assets. Also required for vault folder management. read:creator: >- Access creator profiles, content, and creator-specific information. write:creator: Modify creator profiles, settings, and creator-specific data. read:insights: >- Access analytics, metrics, and insights data for performance tracking. read:tracking_links: >- Read tracking links and the users associated with them, including per-user tracking metadata. write:tracking_links: Create and delete tracking links. read:agency: Read agency information, including the agency's team members. write:agency: >- Manage agency team members and invites, including inviting new team members and creators. ````