Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onlyfanskit.dev/llms.txt

Use this file to discover all available pages before exploring further.

Account activity — new messages, subscriptions, tips, posts, streams — can reach you in real time three ways. Pick based on how you run.

Server-Sent Events

Subscribe to a live HTTP stream from the REST API. No WebSocket client or public receiver needed.

Webhooks

Receive signed HTTP callbacks at a URL you host. Best for serverless and background processing.

WebSocket

Connect directly from the SDK using a short-lived auth token. Lowest latency, you manage the connection.

Which to use

SSEWebhooksWebSocket
SurfaceHosted APIHosted APISDK
You host a servernoyes (a URL)no
Resume after disconnectyes (Last-Event-ID)n/a (push)reconnect
Best fordashboards, live UIsserverless, async jobslow-latency in-process
All three deliver the same OnlyFans events; the difference is transport.

Event names

Events use the OnlyFans event name as their type — message, subscribed, tips, postPublished, stream, and more. Payloads are passed through as { data, meta, ts }.