API and webhooks
Connect your profile to your own tools: keys with scopes and webhooks (PRO+).
The API lets you connect your profile with your own tools: stream overlays, spreadsheets, bots or a sales system. Create keys in the "API and webhooks" tab.
- Each key has separate permissions per category (profile, links, stats, donations, messages, live status and webhooks).
- Webhooks send events (e.g. a new donation, a paid order, a stream start) to your server with an HMAC signature and retry failed deliveries.
- The request log and delivery history help you debug your integration.
What it is useful for
- Your own overlay or chat bot that reacts to new tips the moment they are paid.
- A spreadsheet or bookkeeping system fed by payment confirmations (webhook).
- Automatically updating links or your LIVE status from your streaming tool.
- Weryfikacja kluczy licencyjnych w Twojej aplikacji (opis w artykule Klucze licencyjne).
Permission categories
| Category | What it covers |
|---|---|
| Profile | Name, bio, address, plan; write: name, bio, message button |
| Links | Link list; write: add, edit, reorder, delete |
| Statistics | Views, clicks, sources, devices, live traffic |
| Donations | History, summaries, goal; write: moderation, goal changes |
| Messages | Message inbox; write: mark as read, delete |
| LIVE status | Stream status; write: turning LIVE on and off |
| Webhooks | List and delivery history; write: add, edit, test |
Key security
- You see the full key only once, when it is created. Keep it like a password, outside any code published online.
- Give a key only the permissions it needs and restrict it to your server's IP addresses where possible.
- Verify the signature of every webhook. If a key leaks, delete it in the panel and create a new one.
API documentation OpenAPI 3.1 (JSON)
In the panel: API
Panel → Settings → API
API keys give your tools access to selected profile data. Every key has its own permissions, and webhooks notify your server about events right away, without polling.
Create a separate key for each tool with the least permissions it needs. You can revoke a key at any time without affecting the others.
A webhook is an address on your server where we send events (POST, JSON) signed with HMAC SHA-256. Failed deliveries are retried automatically.
This guide describes the panel. Content about personal data and taxes is informational and is not legal advice.