Getting Started

Info

You need a Restream account to create an application. Sign up

Info

If you have any issues, contact developers@restream.io or suggest an idea.

Step 1: Create a new application

Open the Applications page and click the Create New button.

Step 2: Display name and avatar

Choose a display name and upload an avatar. This information will be shown to users when they authorize your app.

Step 3: Copy your Client ID and Client Secret

On the app settings page you will find two important credentials:

  • Client ID — a unique public identifier for your app. Click the copy button next to it to copy.
  • Client Secret — a private key used to authenticate your app. It is hidden by default. Click on the masked field to reveal it, then use the copy button to copy. Keep this value secret and never expose it publicly.
Warning

If your Client Secret is ever compromised, click the "Regenerate" link to create a new one. Note that your app will stop working until you update the secret in your integration code.

Step 4: Add a Redirect URI

Under the "Redirect URI's" section, add the callback URL where users will be sent after they authorize your app. This is required for the OAuth2 flow.

If you are using a third-party platform or automation tool, it will typically provide you with a specific redirect URL to paste here. Add it by typing or pasting the URL into the input field.

You can add multiple redirect URIs if needed by clicking "Add another".

Step 5: Select scopes

Under the "Scopes" section, check the permissions your application needs. Only select the scopes your integration actually requires.

Info

Changing scopes after users have already authorized your app may require them to re-authenticate.