Skip to content

docs: reference dashboard Redirect URL in provider setup guides #1516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
N2D4 wants to merge 3 commits into from
Closed

docs: reference dashboard Redirect URL in provider setup guides #1516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d6cd74
docs: update provider callback URLs to reference dashboard Redirect URL
devin-ai-integration[bot] May 28, 2026
7a11151
docs: simplify Apple wording and add 'always copy from dashboard' acr…
devin-ai-integration[bot] May 28, 2026
d79370e
docs: simplify callback URLs to use api.hexclave.com directly
devin-ai-integration[bot] May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-mintlify/guides/apps/authentication/auth-providers/apple.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ This guide explains how to set up Apple as an authentication provider with Hexcl
12. From the list, select your new Service ID.
13. Enable **Sign in with Apple** by checking the box.
14. Click **Configure** next to Sign in with Apple.
15. Register your domains (add api.hexclave.com).
16. Add the return URL: `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`
15. Register your domain: `api.hexclave.com`
16. Add `https://api.hexclave.com/api/v1/auth/oauth/callback/apple` as the Return URL.
17. Click **Done**, then **Continue**, and then **Save**.
</Step>

Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This guide explains how to set up Bitbucket as an authentication provider with H
5. Fill out the form with the following details:
- **Name**: Choose a name for your application
- **Description**: Add a brief description of your application
- **Callback URL**: Enter `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`
- **Callback URL**: `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Documentation doesn't match PR objectives—missing dashboard reference instruction.

The PR objectives state that documentation should "include an instruction to always copy the exact Redirect URL from the dashboard" and "reference the Redirect URL shown in the Hexclave dashboard instead of hardcoded callback URLs." However, line 19 still shows a hardcoded URL (https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket) without any instruction to copy from the dashboard.

This creates issues for:

  • Self-hosted users: The hardcoded api.hexclave.com URL won't work for their deployments
  • Maintainability: If callback URL structure changes, documentation becomes outdated
  • Feature alignment: Doesn't support the customCallbackUrl feature mentioned in the PR objectives

Consider rewording to instruct users to copy the value from the dashboard, similar to how the Apple guide was updated (per the review stack context).

📋 Suggested fix to reference dashboard value 
-       - **Callback URL**: `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`
+       - **Callback URL**: Copy the **Redirect URL** shown in the Hexclave dashboard for the Bitbucket provider (e.g., `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket` for Hexclave Cloud)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Callback URL**: `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`
- **Callback URL**: Copy the **Redirect URL** shown in the Hexclave dashboard for the Bitbucket provider (e.g., `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket` for Hexclave Cloud)
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdx` at
line 19, The docs still show a hardcoded Callback URL for the Bitbucket provider
("Callback URL: https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket");
update the text to instruct users to copy the exact Redirect URL value from the
Hexclave dashboard (e.g., refer to "Redirect URL" shown in the dashboard) and
remove the hardcoded URL so self-hosted deployments and the customCallbackUrl
feature are supported; ensure the Bitbucket provider section references
"Redirect URL (copy from dashboard)" and mentions customCallbackUrl where
appropriate.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Intentional — per maintainer direction, these docs assume Hexclave Cloud and use the api.hexclave.com URL directly without dashboard-reference wording.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skipped: comment is from another GitHub bot.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot May 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: This change removes the dashboard reference and replaces it with a hardcoded URL, which is the opposite of what the PR description states ("reference the Redirect URL shown in the Hexclave dashboard, replacing hardcoded callbacks"). The previous text guided users to copy the exact Redirect URL from their dashboard, which is especially important for self-hosted deployments or when using customCallbackUrl. Consider keeping the dashboard reference.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At docs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdx, line 19:

<comment>This change removes the dashboard reference and replaces it with a hardcoded URL, which is the opposite of what the PR description states ("reference the Redirect URL shown in the Hexclave dashboard, replacing hardcoded callbacks"). The previous text guided users to copy the exact Redirect URL from their dashboard, which is especially important for self-hosted deployments or when using `customCallbackUrl`. Consider keeping the dashboard reference.</comment>

<file context>
@@ -16,7 +16,7 @@ This guide explains how to set up Bitbucket as an authentication provider with H
        - **Name**: Choose a name for your application
        - **Description**: Add a brief description of your application
-       - **Callback URL**: Enter the Redirect URL shown in the Hexclave dashboard when configuring Bitbucket (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket` — always copy the exact value from your dashboard)
+       - **Callback URL**: `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`
        - **Permissions**: Under **Account**, select at minimum **Email** and **Read**
     6. Click **Save**.
</file context>
Suggested change
- **Callback URL**: `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`
- **Callback URL**: Enter the Redirect URL shown in the Hexclave dashboard when configuring Bitbucket (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket` — always copy the exact value from your dashboard)
Fix with Cubic

- **Permissions**: Under **Account**, select at minimum **Email** and **Read**
6. Click **Save**.
7. You'll be redirected to the OAuth consumers page. Select your newly created consumer to view its details.
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/guides/apps/authentication/auth-providers/gitlab.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide explains how to set up GitLab as an authentication provider with Hexc
3. In the left sidebar, select **Applications** > **Add new application**.
4. Fill out the form with the following details:
- **Name**: Choose a name for your application
- **Redirect URI**: Enter `https://api.hexclave.com/api/v1/auth/oauth/callback/gitlab`
- **Redirect URI**: `https://api.hexclave.com/api/v1/auth/oauth/callback/gitlab`
- **Scopes**: Select at minimum the `profile` and `email` scopes
5. Click **Save application**.
6. GitLab will display your **Application ID** and **Secret**. Make note of these values as you'll need them for the next steps.
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/guides/apps/authentication/auth-providers/linkedin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This guide explains how to set up LinkedIn as an authentication provider with He
5. Enter the **App description** and your **Business email**.
6. Check the **Legal agreement** box and click **Create app**.
7. On your app's dashboard, click **Auth** tab from the left sidebar.
8. Under **OAuth 2.0 settings**, add the following redirect URL: `https://api.hexclave.com/api/v1/auth/oauth/callback/linkedin`
8. Under **OAuth 2.0 settings**, add `https://api.hexclave.com/api/v1/auth/oauth/callback/linkedin`
9. Under **Products**, request access to **Sign In with LinkedIn** by clicking **Request access**. Complete any required information.
10. Under **OAuth 2.0 scopes**, make sure at least the following scopes are selected:
- `r_emailaddress`
Expand Down
Loading