π¨βπ»API Key Management
Fuul provides four types of API keys, each designed for specific use cases. Using the right key type ensures your integration is secure and your data stays protected.
Key types
Read-Only
Frontend
Read data only
Displaying leaderboards, rewards, and conversion info
send:tracking_event
Frontend
Read + send tracking events
Tracking pageview and connect_wallet events
send:trigger_event
Backend only
Read + send trigger events
Sending custom offchain trigger events (e.g., social actions)
service_role
Backend only
Full access
Creating/updating audiences programmatically
Never expose send:trigger_event or service_role keys in the frontend. A malicious user could send fake events or modify your program data.
Creating an API key
Go to Settings > New API Key in the Fuul dashboard
Select the key type you need
Name it and click Create
Copy the key from the modal β it won't be shown again
Which key should I use?
Most frontend integrations only need a single send:tracking_event key. This covers both reading data (leaderboards, rewards) and sending the tracking events required for referral attribution.
White-label hub with referral tracking
send:tracking_event
Read-only dashboard or leaderboard widget
read-only
Backend sending custom events (Discord, Twitter, etc.)
send:trigger_event
Backend managing audiences via API
service_role
For more details on audience management, see Managing Audiences.
Last updated