Skip to main content
OFAuth sends webhook requests to the URLs you add as destinations. These requests report account access changes and the OnlyFans activity events you enable. Follow Set up webhooks to configure a destination and Verify and handle webhooks to receive deliveries.

Envelope

Normal events use the JSON format below, called an envelope. The fields inside data depend on type. The destination verification challenge is a separate message.

Event catalogs

Lifecycle events report changes to accounts and access. An authorization records the accounts and permissions that an owner approved. OnlyFans activity events describe messages, posts, stories, and other supported activity. Each catalog lists event types and their fields.

Destination verification

Before normal event delivery, OFAuth sends a signed JSON body with type: "ofauth.webhook.challenge" and a challenge string. This verification message does not use the normal event envelope. Verify its signature and return the exact challenge string as a text/plain response body with a 2xx status. Do not add JSON quotes or a newline. See the receiver example.

Signatures

Deliveries use Standard Webhooks with webhook-id, webhook-timestamp, and webhook-signature headers. Verify the unmodified request body with the destination’s signing secret before using any field. A Standard Webhooks verifier checks the signature and timestamp.

Acknowledgements and retries

Save events before returning a 2xx success response if they change data in your app. Return the response promptly, then process the saved event. OFAuth retries failed deliveries with a wait between attempts.

Idempotency and ordering

Use eventId as the key for saved events. Receiving the same eventId again must not repeat a customer update. For one linked account, a higher order represents a newer event. Deliveries can arrive out of order after retries. Do not compare ordering values across accounts. Lifecycle events tell you that access or account details changed. Read linked accounts when you need current names, scopes, or status. For events about an authorization, fetch its current accounts and permissions. The order in which events arrive may differ from the order in which changes happened.

Test deliveries

To receive deliveries on your computer, expose your local receiver with a Cloudflare Quick Tunnel.
The receiver example’s optional checks use sample test data with test: true and made-up IDs. Keep that data out of customer records. The flag alone does not mean that the IDs are made up. Events about account and access changes in Sandbox and Test also have test: true. Test events can describe real accounts you chose for testing. Use environment to keep Sandbox, Test, and Live state separate, and process each environment’s account events against its own records. Lifecycle events are delivered through webhooks. OnlyFans activity can also arrive over a Server-Sent Events stream, whose envelope uses receivedAt and differs from the webhook envelope.