Skip to main content

OAuth 2.0

The Tiltify API implements the OAuth 2.0 authorization protocol.

Which OAuth Flow should I use?​

Choosing one flow over the other depends on what type of application you are building, and whether or not you need to know who the user is on Tiltify.

Client Credentials​

By using the Client Credentials Flow, you can generate an Application Access Token that will grant you access to all of the public facing data available on Tiltify.

  • Only public data
  • Manage your own resources (in /private endpoints)
  • Single request OAuth flow

Example Use Case​

This flow is recommended for applications that require little to zero user input. For example, if you are building an overlay to be used by your team for a single event. The Tiltify users don't need to input anything, and just link to your custom overlay in their OBS.

Authorization Code​

By using the Authorization Code Flow, you can generate a User Access Token that will grant you access to all of the public facing data available on Tiltify, as well as tell you who the user is on Tiltify.

  • Includes all public data
  • Can see the user's Tiltify user_id without asking
  • Some user specific resources (in /private endpoints)
  • Multi phased OAuth flow

Example Use Case​

This flow is recomeded for applications that need to know who the user is on Tiltify. For example, if you have an application that manages all of a streamer's alerts, and you need to know who the user is on Tiltify in order to build Tiltify Donation alerts into your application. This flow allows you to see who the user is on Tiltify, then you can query the api for all events that that user_id is fundraising for, and connect to their campaigns programatically.