Developers
The Fansquare API
Connect Fansquare to your own tools with the public API and webhooks.
The public API gives your own tools access to the agency's data: creators, employees, sales and revenue, sent messages, fans, posts. Webhooks notify your server as soon as a sale comes in or a fan changes employee. Everything is set up in Settings › Developer API, reserved for the agency owner.
The technical details are in the API reference.
What it is for
The API is for server-to-server integrations: a revenue spreadsheet fed by a script, an internal dashboard, a BI tool, a bot. Call it from your server, so the key stays out of the browser.
API keys
Settings › Developer API › API lists the agency's keys. Each one is identified by its name and by the start of the key, fsq_live_ followed by a few characters, never by the full key.
- 1
Click Generate key
The button is at the top right of API keys.
- 2
Set up the key
Give it a Name, then choose its Access: Read only, Full access or Custom, permission by permission. If needed, limit it to a Selection of creators, and set an Expiration: Never, In 30 days, In 90 days or In 1 year.
- 3
Copy the key
After Generate key, the key is shown only once. Click Copy key, then store it in your secrets manager.
Anyone who holds a key can read the agency's data. A lost key is never shown again: revoke it and generate a new one.
The icon at the end of a row revokes the key. Revocation is permanent. An agency keeps at most 20 keys that are not revoked. The details of keys and their access are in the reference.
Webhooks
Settings › Developer API › Webhooks sends the agency's events to your HTTPS addresses as they happen: Sale created, Sale refunded, Assignment updated, AI relaunch or stop requested.
Add endpoint asks for a name, the Destination URL, the Events to receive and the creators concerned. Every delivery is signed: the signing secret, which starts with fsq_whsec_, is shown only once when you create the endpoint. On each row, you can Edit, Send a test, Pause, Rotate secret or Delete.
The Activity tab counts the deliveries of the last 7 days and lists the Recent failures, which a click on Resend sends again. An endpoint that fails too often switches to Disabled after repeated failures. To verify signatures and process deliveries, see webhooks in the reference.