Overview
Guides for building against the Popplio API.
This section covers the mechanics of building against Popplio: how auth and permissions work, what the rate limits are, and how to report stats, handle votes, and receive webhooks. For the endpoints themselves, see the API Reference.
In this section
Authentication
Getting and using User-Auth, Bot-Auth, and scoped session tokens.
Teams & Permissions
How the flat permission model works, and how to check what a user can do.
Rate Limits
How Popplio's rate limiting works and how to handle it.
Posting Bot Stats
Keeping your bot's server count and presence up to date.
Posting Server Stats
Self-reporting your server's member count instead of waiting on the automatic sync.
Voting via the API
Casting a vote programmatically, including the proof-of-work captcha flow.
Webhooks
Getting notified about votes and other events in real time.