(waiting for feature) Feat/connected app employment hero #416
Conversation
New topic for employment hero connected app.
Add employment hero connected app ref
|
Warning Rate limit exceeded@clairekinde11 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 35 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe documentation for integrating connected apps in Kinde was updated to add "Employment Hero" as a supported connected app. This includes updating the main list of available connected apps and introducing a new, dedicated guide detailing the Employment Hero integration process. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Kinde Docs
participant Employment Hero Developer Portal
User->>Kinde Docs: Access "Add Connected Apps" guide
Kinde Docs-->>User: Display list including Employment Hero
User->>Kinde Docs: Open Employment Hero integration guide
Kinde Docs-->>User: Show prerequisites and setup steps
User->>Employment Hero Developer Portal: Register new app, obtain credentials
User->>Kinde Docs: Follow final configuration steps using credentials
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying kinde-docs-previews with
|
| Latest commit: |
0c91ca8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a9c1a9f5.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://feat-connected-app-employmen.kinde-docs-previews.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
src/content/docs/integrate/connected-apps/employment-hero.mdx (1)
19-19: Clarify external links
Consider rephrasing the account requirement for greater clarity (e.g., "You also need an Employment Hero developer account to register an app"). Additionally, confirm that the anchor#obtain-credentialsinhttps://developer.employmenthero.com/api-references/#obtain-credentialsis still valid.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/content/docs/integrate/connected-apps/add-connected-apps.mdx(1 hunks)src/content/docs/integrate/connected-apps/employment-hero.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/integrate/connected-apps/employment-hero.mdx
[misspelling] ~21-~21: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ntials) to get you started ## Register a Employment Hero app This is Step 2 of ...
(EN_A_VS_AN)
[uncategorized] ~32-~32: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: .... 8. Copy and paste these in a text file or somewhere you can easily access them ag...
(COMMA_COMPOUND_SENTENCE)
🔇 Additional comments (5)
src/content/docs/integrate/connected-apps/add-connected-apps.mdx (1)
40-40: Add Employment Hero entry to Step 2 list
The new list item correctly introduces Employment Hero alongside the existing connected apps. Please verify that the target path/integrate/connected-apps/employment-hero/matches the actual file location and routing configuration.src/content/docs/integrate/connected-apps/employment-hero.mdx (4)
1-9: Front matter configuration
Thepage_id,title,sidebar.order, andrelatedArticlesentries are present and follow the established pattern for connected-app pages.
11-11: Introduction clarity
The opening sentence succinctly states the purpose of this page.
13-17: Prerequisite steps
The "Before you begin" section properly lists the required setup steps and matches the style of other connected-app guides.
34-38: Complete configuration instructions
The "Finish configuring the connection in Kinde" section clearly directs users to Step 3 of the main guide and outlines the final credential requirements.
| 2. Go to the Developer Portal (under your account profile). | ||
| 3. Select **Add application**. | ||
| 4. Enter a name for the app. | ||
| 5. Enter the **Redirect URI**. This is the **Allowed Callback** URL you have entered in your Kinde app, where uers are redirected to after auth. |
There was a problem hiding this comment.
@clairekinde11 typo on users :)
There was a problem hiding this comment.
@clairekinde11 I think we can remove the you have entered in your Kinde app part as Kinde provides this
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| 2. Go to the Developer Portal (under your account profile). | ||
| 3. Select **Add application**. | ||
| 4. Enter a name for the app. | ||
| 5. Enter the **Redirect URI**. This is the **Allowed Callback** URL you have entered in your Kinde app, where uers are redirected to after auth. |
There was a problem hiding this comment.
@clairekinde11 I think we can remove the you have entered in your Kinde app part as Kinde provides this
| 4. Enter a name for the app. | ||
| 5. Enter the **Redirect URI**. This is the **Allowed Callback** URL you have entered in your Kinde app, where uers are redirected to after auth. | ||
| 6. Select the scopes you want to include in the connection. | ||
| 7. Select **Create**. A Client ID and Client Secret is generated for the app. |
There was a problem hiding this comment.
@clairekinde11 - not sure if we need to be more specific, but after hitting create you'll need to select action > view to get the client credentials
|
|
||
| ## Finish configuring the connection in Kinde | ||
|
|
||
| You’ll need the **Client ID** and **Secret** that you copied above. You’ll also need the Kinde app callback URL. |
There was a problem hiding this comment.
@clairekinde11 at this point, you won't need the callback anymore
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
clairekinde11
changed the title
New topic and reference for adding employment hero app
Summary by CodeRabbit