docs: reference dashboard Redirect URL in provider setup guides#1516
docs: reference dashboard Redirect URL in provider setup guides#1516N2D4 wants to merge 3 commits into
Conversation
Co-Authored-By: Konstantin Wohlwend <n2d4xc@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation updates across four OAuth provider setup guides standardize how Hexclave callback and redirect URLs are presented: the Apple guide differentiates domain registration between Cloud and self-hosted deployments while instructing users to copy the Redirect URL from the dashboard; Bitbucket, GitLab, and LinkedIn guides reword instructions to reference the dashboard value directly instead of using entry directives. ChangesOAuth Provider Redirect URL Consolidation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR updates all 12 OAuth provider setup guides to instruct users to copy the Redirect URL directly from the Hexclave dashboard rather than hardcoding the Hexclave Cloud URL, aligning the docs with the
Confidence Score: 5/5Documentation-only change across 12 provider guides; no runtime code is modified. Every change is a string replacement in .mdx docs — the new wording correctly directs users to the dashboard Redirect URL and preserves the Hexclave Cloud URL as a concrete example. The apple.mdx file gains a small additional self-hosted note that is accurate and consistent with the intent of the PR. No logic, config, or code paths are touched. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User clicks Sign in with OAuth] --> B[Hexclave initiates OAuth flow]
B --> C[Provider receives authorization request]
C --> D{User consents?}
D -- Yes --> E[Provider calls back to Redirect URL]
D -- No --> F[Login cancelled]
E --> G[Hexclave validates callback]
G --> H[User session created]
Reviews (1): Last reviewed commit: "docs: update provider callback URLs to r..." | Re-trigger Greptile |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs-mintlify/guides/apps/authentication/auth-providers/apple.mdx (1)
33-33: 💤 Low valueConsider simplifying the wording to match other provider guides.
The phrase "return URL shown as the Redirect URL" is slightly awkward compared to the simpler pattern used in other provider files. While it attempts to bridge Apple's "return URL" terminology with Hexclave's "Redirect URL" field name, the construction makes the sentence harder to parse.
✍️ Suggested wording to match other provider guides
- 16. Add the return URL shown as the Redirect URL in the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`) + 16. Add the Redirect URL shown in the Hexclave dashboard when configuring Apple as the return URL (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)Or even simpler:
- 16. Add the return URL shown as the Redirect URL in the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`) + 16. Add the Redirect URL shown in the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)🤖 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/apple.mdx` at line 33, The sentence "Add the return URL shown as the Redirect URL in the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)" is awkward; simplify it to match other provider guides by replacing it with a clearer phrasing like "Add the Redirect URL from the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)". Locate and update the line in auth-providers/apple.mdx that contains "return URL shown as the Redirect URL" and swap in the simpler "Redirect URL from the Hexclave dashboard" wording to maintain consistency.
🤖 Prompt for all review comments with 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.
Inline comments:
In `@docs-mintlify/guides/apps/authentication/auth-providers/microsoft.mdx`:
- Line 22: Replace the absolute claim that the Microsoft callback is always
`https://api.hexclave.com/api/v1/auth/oauth/callback/microsoft` with wording
that instructs users to copy the Redirect URL shown in the Hexclave dashboard
(the dashboard value is the single source of truth), and optionally note that
some cloud/legacy tenants may use alternate domains (e.g.,
`https://api.stack-auth.com/...`) so do not hardcode the example URL in the
guide—use the dashboard-provided Redirect URL instead.
---
Nitpick comments:
In `@docs-mintlify/guides/apps/authentication/auth-providers/apple.mdx`:
- Line 33: The sentence "Add the return URL shown as the Redirect URL in the
Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is
`https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)" is awkward;
simplify it to match other provider guides by replacing it with a clearer
phrasing like "Add the Redirect URL from the Hexclave dashboard when configuring
Apple (for Hexclave Cloud, this is
`https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)". Locate and update
the line in auth-providers/apple.mdx that contains "return URL shown as the
Redirect URL" and swap in the simpler "Redirect URL from the Hexclave dashboard"
wording to maintain consistency.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: edfe6f8a-7f4d-4e7d-b7c5-e358f330097f
📒 Files selected for processing (12)
docs-mintlify/guides/apps/authentication/auth-providers/apple.mdxdocs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdxdocs-mintlify/guides/apps/authentication/auth-providers/discord.mdxdocs-mintlify/guides/apps/authentication/auth-providers/facebook.mdxdocs-mintlify/guides/apps/authentication/auth-providers/github.mdxdocs-mintlify/guides/apps/authentication/auth-providers/gitlab.mdxdocs-mintlify/guides/apps/authentication/auth-providers/google.mdxdocs-mintlify/guides/apps/authentication/auth-providers/linkedin.mdxdocs-mintlify/guides/apps/authentication/auth-providers/microsoft.mdxdocs-mintlify/guides/apps/authentication/auth-providers/spotify.mdxdocs-mintlify/guides/apps/authentication/auth-providers/twitch.mdxdocs-mintlify/guides/apps/authentication/auth-providers/x-twitter.mdx
…oss all providers Co-Authored-By: Konstantin Wohlwend <n2d4xc@gmail.com>
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 12 files
Tip: cubic could auto-approve low-risk PRs like this, if it thinks it's safe to merge. Learn more
Re-trigger cubic
|
Actionable comments posted: 0 |
Co-Authored-By: Konstantin Wohlwend <n2d4xc@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with 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.
Inline comments:
In `@docs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdx`:
- 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.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 23f2a2d7-6cea-4073-82c9-e9dfee3919c8
📒 Files selected for processing (4)
docs-mintlify/guides/apps/authentication/auth-providers/apple.mdxdocs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdxdocs-mintlify/guides/apps/authentication/auth-providers/gitlab.mdxdocs-mintlify/guides/apps/authentication/auth-providers/linkedin.mdx
✅ Files skipped from review due to trivial changes (2)
- docs-mintlify/guides/apps/authentication/auth-providers/linkedin.mdx
- docs-mintlify/guides/apps/authentication/auth-providers/gitlab.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs-mintlify/guides/apps/authentication/auth-providers/apple.mdx
| - **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` |
There was a problem hiding this comment.
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.comURL won't work for their deployments - Maintainability: If callback URL structure changes, documentation becomes outdated
- Feature alignment: Doesn't support the
customCallbackUrlfeature 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.
| - **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.
There was a problem hiding this comment.
Intentional — per maintainer direction, these docs assume Hexclave Cloud and use the api.hexclave.com URL directly without dashboard-reference wording.
There was a problem hiding this comment.
Skipped: comment is from another GitHub bot.
There was a problem hiding this comment.
Additional Suggestion:
All 12 OAuth provider guides were reverted from referencing Redirect URLs shown in the Hexclave dashboard back to hardcoding api.hexclave.com URLs, undoing the purpose of the PR that added support for self-hosted deployments and the customCallbackUrl feature.
There was a problem hiding this comment.
2 issues found across 12 files (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs-mintlify/guides/apps/authentication/auth-providers/github.mdx">
<violation number="1">
P2: This change removes the instruction to copy the Redirect URL from the dashboard and hardcodes the cloud URL instead — the opposite of what the PR description states. Self-hosted users or those using `customCallbackUrl` would get incorrect instructions. Consider keeping the dashboard reference, e.g.:
> For **Authorization callback URL**, add the Redirect URL shown in the Hexclave dashboard (for Hexclave Cloud, the default is `https://api.hexclave.com/api/v1/auth/oauth/callback/github`).</violation>
</file>
<file name="docs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdx">
<violation number="1" location="docs-mintlify/guides/apps/authentication/auth-providers/bitbucket.mdx:19">
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.</violation>
</file>
Tip: Review your code locally with the cubic CLI to iterate faster.
Fix all with cubic | Re-trigger cubic
| - **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` |
There was a problem hiding this comment.
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>
| - **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) |
1 participant
Updated all 12 OAuth provider documentation pages to reference the Redirect URL shown in the Hexclave dashboard, with the Hexclave Cloud URL as the default. This aligns with the
customCallbackUrlfeature from #1512.Link to Devin session: https://app.devin.ai/sessions/e376c0b00c6c41219c02d7a3efb36089
Requested by: @N2D4
Summary by cubic
Updated all 12 OAuth provider setup guides to use the Redirect URL shown in the Hexclave dashboard, replacing hardcoded callbacks. Simplified examples to use
https://api.hexclave.com/...by default, reiterated “always copy from the dashboard,” and clarified Hexclave Cloud vs self‑hosted (with simpler Apple domain wording), aligning with thecustomCallbackUrlfeature.Written for commit d79370e. Summary will update on new commits.
Review in cubic
Summary by CodeRabbit