Skip to content

Commit 2f568ca

Browse files
authored
chore: Update OAuth callback instructions (#447)
1 parent 9d3831e commit 2f568ca

File tree

23 files changed

+67
-44
lines changed

23 files changed

+67
-44
lines changed

pages/home/auth-providers/asana.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ When creating your app, use the following settings:
4747
- Set an appropriate App name, description and icon. This will be visible to your users authorizing access to your app.
4848
- Take note of the **Client ID** and **Client Secret**.
4949
- In the OAuth settings:
50-
- Under "Redirect URLs", click **Add Redirect URL** and add `https://cloud.arcade.dev/api/v1/oauth/callback`.
50+
- Under "Redirect URLs", click **Add Redirect URL** and add the redirect URL generated by Arcade (see below).
5151
- Under "Permission Scopes", select "Full Permissions"
5252
- In the "App Listing Details" section, optionally add more information about your app.
5353
- In the "Manage Distribution" section, under "Choose a distribution method", select "Any workspace".
@@ -79,7 +79,7 @@ We show both options step-by-step below.
7979

8080
#### Access the Arcade Dashboard
8181

82-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
82+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
8383

8484
#### Navigate to the OAuth Providers page
8585

@@ -93,6 +93,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
9393
- Choose a unique **ID** for your provider (e.g. "my-asana-provider").
9494
- Optionally enter a **Description**.
9595
- Enter the **Client ID** and **Client Secret** from your Asana app.
96+
- Note the **Redirect URL** generated by Arcade. This must be added to your Asana app's Redirect URLs.
9697

9798
#### Create the provider
9899

pages/home/auth-providers/atlassian.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Before showing how to configure your Atlassian app credentials, let's go through
3434
### Create an Atlassian app
3535

3636
- Create a Atlassian app in the [Atlassian developer console](https://developer.atlassian.com/console/myapps/)
37-
- In the Authorization tab, click the "Add" action button and set the Callback URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
37+
- In the Authorization tab, click the "Add" action button and set the Callback URL to the redirect URL generated by Arcade (see below)
3838
- In the Permissions tab, enable any permissions you need for your app
3939
- In the Settings tab, copy the Client ID and Secret to use below
4040

@@ -56,7 +56,7 @@ We show both options step-by-step below.
5656

5757
#### Access the Arcade Dashboard
5858

59-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
59+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
6060

6161
#### Navigate to the OAuth Providers page
6262

@@ -70,6 +70,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
7070
- Choose a unique **ID** for your provider (e.g. "my-atlassian-provider").
7171
- Optionally enter a **Description**.
7272
- Enter the **Client ID** and **Client Secret** from your Atlassian app.
73+
- Note the **Redirect URL** generated by Arcade. This must be added to your Atlassian app as a Callback URL.
7374

7475
#### Create the provider
7576

pages/home/auth-providers/discord.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Before showing how to configure your Discord app credentials, let's go through t
3434
### Create a Discord app
3535

3636
- Create a Discord Application in the [Discord developer portal](https://discord.com/developers/applications)
37-
- In the OAuth2 tab, set the redirect URI to: `https://cloud.arcade.dev/api/v1/oauth/callback`
37+
- In the OAuth2 tab, set the redirect URI to the redirect URL generated by Arcade (see below)
3838
- Copy the Client ID and Client Secret (you may need to reset the secret to see it)
3939

4040
Next, add the Discord app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the `engine.yaml` file directly (for a self-hosted instance).
@@ -57,7 +57,7 @@ We show both options step-by-step below.
5757

5858
#### Access the Arcade Dashboard
5959

60-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
60+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
6161

6262
#### Navigate to the OAuth Providers page
6363

@@ -71,6 +71,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
7171
- Choose a unique **ID** for your provider (e.g. "my-discord-provider").
7272
- Optionally enter a **Description**.
7373
- Enter the **Client ID** and **Client Secret** from your Discord app.
74+
- Note the **Redirect URL** generated by Arcade. This must be added to your Discord app's Redirect URIs.
7475

7576
#### Create the provider
7677

pages/home/auth-providers/dropbox.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Before showing how to configure your Dropbox app credentials, let's go through t
3434
### Create a Dropbox app
3535

3636
- Create a Dropbox Application in the [Dropbox App Console](https://www.dropbox.com/developers/apps)
37-
- In the Settings tab, under the "OAuth 2" section, set the redirect URI to: `https://cloud.arcade.dev/api/v1/oauth/callback`
37+
- In the Settings tab, under the "OAuth 2" section, set the redirect URI to the redirect URL generated by Arcade (see below)
3838
- In the Permissions tab, add any scopes that your app will need
3939
- In the Settings tab, copy the App key (Client ID) and App secret (Client Secret), which you'll need below
4040

@@ -58,7 +58,7 @@ We show both options step-by-step below.
5858

5959
#### Access the Arcade Dashboard
6060

61-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
61+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
6262

6363
#### Navigate to the OAuth Providers page
6464

@@ -72,6 +72,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
7272
- Choose a unique **ID** for your provider (e.g. "my-dropbox-provider").
7373
- Optionally enter a **Description**.
7474
- Enter the **Client ID** and **Client Secret** from your Dropbox app.
75+
- Note the **Redirect URL** generated by Arcade. This must be added to your Dropbox app's Redirect URIs.
7576

7677
#### Create the provider
7778

pages/home/auth-providers/github.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Before showing how to configure your GitHub app credentials, let's go through th
3737
- Choose the permissions you need for your app
3838
- At a minimum, you must enable read-only access to the Account > Email addresses permission
3939
- To access repo data, you must enable at least the Repository > Contents permission
40-
- Set the redirect URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
40+
- Set the redirect URL to the redirect URL generated by Arcade (see below)
4141
- Leave "Expire user authorization tokens" **checked**
4242
- Leave "Request user authorization (OAuth) during installation" **unchecked**
4343
- Leave "Setup URL" blank and "Redirect on update" **unchecked**
@@ -69,7 +69,7 @@ We show both options step-by-step below.
6969

7070
#### Access the Arcade Dashboard
7171

72-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
72+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
7373

7474
#### Navigate to the OAuth Providers page
7575

@@ -83,6 +83,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
8383
- Choose a unique **ID** for your provider (e.g. "my-github-provider").
8484
- Optionally enter a **Description**.
8585
- Enter the **Client ID** and **Client Secret** from your GitHub app.
86+
- Note the **Redirect URL** generated by Arcade. This must be added to your GitHub app's Redirect URLs.
8687

8788
#### Create the provider
8889

pages/home/auth-providers/google.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Before showing how to configure your Google app credentials, let's go through th
3939
- At a minimum, you must enable these scopes:
4040
- `https://www.googleapis.com/auth/userinfo.email`
4141
- `https://www.googleapis.com/auth/userinfo.profile`
42-
- Set the redirect URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
42+
- Add the redirect URL generated by Arcade (see below) to the Authorized redirect URIs list
4343
- Copy the client ID and client secret to use below
4444

4545
Next, add the Google app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the `engine.yaml` file directly (for a self-hosted instance).
@@ -62,7 +62,7 @@ We show both options step-by-step below.
6262

6363
#### Access the Arcade Dashboard
6464

65-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
65+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
6666

6767
#### Navigate to the OAuth Providers page
6868

@@ -76,6 +76,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
7676
- Choose a unique **ID** for your provider (e.g. "my-google-provider").
7777
- Optionally enter a **Description**.
7878
- Enter the **Client ID** and **Client Secret** from your Google app.
79+
- Note the **Redirect URL** generated by Arcade. This must be added to your Google app's Authorized redirect URIs list.
7980

8081
#### Create the provider
8182

pages/home/auth-providers/hubspot.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Follow [Hubspot's tutorial](https://developers.hubspot.com/docs/guides/apps/publ
4646
When creating your app, use the following settings:
4747

4848
- Under **App Info**, choose a name, description, and logo for your app
49-
- Under **Auth**, enter the **Redirect URL**: `https://cloud.arcade.dev/api/v1/oauth/callback`
49+
- Under **Auth**, enter the **Redirect URL** generated by Arcade (see below)
5050
- In the **Scopes** section, click **Add Scope** and add the following scopes with the **Conditionally Required** scope type:
5151
- `crm.objects.companies.read`
5252
- `crm.objects.contacts.read`
@@ -85,7 +85,7 @@ We show both options step-by-step below.
8585

8686
#### Access the Arcade Dashboard
8787

88-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
88+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
8989

9090
#### Navigate to the OAuth Providers page
9191

@@ -99,6 +99,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
9999
- Enter `hubspot` as the **ID** for your provider
100100
- Optionally enter a **Description**.
101101
- Enter the **Client ID** and **Client Secret** from your Hubspot app.
102+
- Note the **Redirect URL** generated by Arcade. This must be set as your Hubspot app's Redirect URL.
102103

103104
#### Create the provider
104105

pages/home/auth-providers/linear.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before showing how to configure your Linear app credentials, let's go through th
3030
- It is **highly recommended** to first [create a new Linear workspace](https://linear.app/join) for the purpose of managing the OAuth2 Application.
3131
- Create a new public OAuth2 Application in your [integration's settings page](https://linear.app/settings/api/applications/new).
3232
- Fill out your application specific information such as application name and description.
33-
- Set the Callback URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
33+
- Set the Callback URL to the redirect URL generated by Arcade (see below)
3434
- Toggle the **Public** switch to enable public access to the application if you want other workspaces to be able to use your application.
3535
- Once you complete creating your integration, copy the client ID and client secret to use below.
3636

@@ -54,7 +54,7 @@ We show both options step-by-step below.
5454

5555
#### Access the Arcade Dashboard
5656

57-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
57+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
5858

5959
#### Navigate to the OAuth Providers page
6060

@@ -68,6 +68,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
6868
- Choose a unique **ID** for your provider (e.g. "my-linear-provider").
6969
- Optionally enter a **Description**.
7070
- Enter the **Client ID** and **Client Secret** from your Linear app.
71+
- Note the **Redirect URL** generated by Arcade. This must be set as your Linear app's Callback URL.
7172

7273
#### Create the provider
7374

pages/home/auth-providers/linkedin.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before showing how to configure your LinkedIn app credentials, let's go through
3030
- Follow LinkedIn's guide to [setting up user authorization](https://learn.microsoft.com/en-us/linkedin/shared/authentication/authentication)
3131
- On the Products tab, add the products you need for your app (e.g. "Share on LinkedIn")
3232
- At a minimum, you _must_ add the "Sign In with LinkedIn using OpenID Connect" product
33-
- On the Auth tab, set the redirect URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
33+
- On the Auth tab, set the redirect URL to the redirect URL generated by Arcade (see below)
3434
- Copy the client ID and client secret to use below
3535

3636
Next, add the LinkedIn app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the `engine.yaml` file directly (for a self-hosted instance).
@@ -53,7 +53,7 @@ We show both options step-by-step below.
5353

5454
#### Access the Arcade Dashboard
5555

56-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
56+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
5757

5858
#### Navigate to the OAuth Providers page
5959

@@ -67,6 +67,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
6767
- Choose a unique **ID** for your provider (e.g. "my-linkedin-provider").
6868
- Optionally enter a **Description**.
6969
- Enter the **Client ID** and **Client Secret** from your LinkedIn app.
70+
- Note the **Redirect URL** generated by Arcade. This must be set as your LinkedIn app's redirect URL.
7071

7172
#### Create the provider
7273

pages/home/auth-providers/microsoft.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Before showing how to configure your Microsoft app credentials, let's go through
3535

3636
- Follow Microsoft's guide to [registering an app with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app)
3737
- Choose the permissions (scopes) you need for your app. Refer to the [section below](#arcade-microsoft-toolkits-scopes) for a list of scopes needed by the Arcade Microsoft Toolkits, in case you intend to use them.
38-
- Set the redirect URL to: `https://cloud.arcade.dev/api/v1/oauth/callback`
38+
- Set the redirect URL to the redirect URL generated by Arcade (see below)
3939
- Copy the client ID and client secret to use below
4040

4141
Next, add the Microsoft app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the `engine.yaml` file directly (for a self-hosted instance).
@@ -69,7 +69,7 @@ We show both options step-by-step below.
6969

7070
#### Access the Arcade Dashboard
7171

72-
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at `http://localhost:9099/dashboard`. Adjust the host and port number to match your environment.
72+
To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://api.arcade.dev/dashboard). If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard. Adjust the host and port number to match your environment.
7373

7474
#### Navigate to the OAuth Providers page
7575

@@ -83,6 +83,7 @@ To access the Arcade Cloud dashboard, go to [api.arcade.dev/dashboard](https://a
8383
- Choose a unique **ID** for your provider (e.g. "my-microsoft-provider").
8484
- Optionally enter a **Description**.
8585
- Enter the **Client ID** and **Client Secret** from your Microsoft app.
86+
- Note the **Redirect URL** generated by Arcade. This must be set as your Microsoft app's redirect URL.
8687

8788
#### Create the provider
8889

0 commit comments

Comments
 (0)