Skip to main content

Supported OAuth Scopes

This document describes what every OAuth Scope available in the Tiltify API is, and what endpoints it grants access to.

General Scopes​

This scopes grant access to entire paths on the api.

public​

This is the default scope and grants access to all public data in the API. You will want to request this scope if you plan on using any endpoint prefixed with /api/public.

Granular Scopes​

These scopes grant access to specific endpoints that are prefixed with /api/private. Each endpoint with this prefix has it's own scope requirements.

webhooks:write​

This scope will grant access to the webhook related resources.

MethodEndpoint
POST/api/private/webhook_endpoints/:webhook_endpoint_id/activate
DELETE/api/private/webhook_endpoints/:webhook_endpoint_id/webhook_subscriptions/:event_id
PUT/api/private/webhook_endpoints/:webhook_endpoint_id/webhook_subscriptions/:event_id
POST/api/private/webhook_relays/:webhook_relay_id/webhook_relay_keys

Using Multiple Scopes​

If you require multiple scopes, you can delimit them with a space when requesting either your User Access Grant or Application Access Token.

JSON Request Body Example:​

{
  // <...>
  "scope": "public webhooks:write"
}

Url Query Param Example:​

Make sure to url encode the spaces.

?<...>&scope=public%20webhooks%3Awrite