Uh oh!
There was an error while loading. Please reload this page.
docs(greenhouse): switch IAM guide to Harvest V3 OAuth credentials - #398
Closed
jerann wants to merge 4 commits into
Closed
docs(greenhouse): switch IAM guide to Harvest V3 OAuth credentials#398jerann wants to merge 4 commits into
jerann wants to merge 4 commits into
Conversation
…and reconnection Greenhouse is retiring Harvest v1/v2 API keys, so the connection guide now walks through creating Harvest V3 OAuth credentials (Client ID/Secret), configuring scopes, and reconnecting an existing account instead of recreating it. Drops screenshots that show the old single-API-key flow (image2, image3, image6, image7); keeps the two that are still accurate (image1 nav path, the user-ID-in-URL screenshot). New Dev Center and Hub-reconnect screenshots are a follow-up capture, not included here.
Renames the Dev Center menu item to API Credential Management, adds the Configure > Users path and Export to Excel tip for finding a User ID, adds the harvest:user_roles:list scope needed for the Roles resource, folds the scope step into the Steps block, and bolds UI labels in line with the other connection guides.
Contributor
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Greenhouse IAM connection guide to reflect Greenhouse’s migration away from Harvest v1/v2 API keys by documenting the Harvest V3 OAuth (Client ID/Client Secret) credential flow, and adds clear reconnection instructions for existing StackOne accounts.
Changes:
- Replaces the Harvest API key instructions with steps for creating Harvest V3 (OAuth) credentials and enabling the required scopes.
- Adds guidance for optionally providing a Greenhouse User ID, including constraints around Site Admin permissions.
- Adds a dedicated “Reconnect your existing account” section and updates the API reference link to the Harvest docs authentication page.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+11
to
+13
| Greenhouse is retiring the Harvest v1 and v2 API keys. The StackOne integration now connects using Harvest V3 OAuth credentials, a Client ID and Client Secret you generate in the Greenhouse Dev Center, instead of a single API key. | ||
| ## Generating Harvest API Key | ||
| If you already have a Greenhouse account connected to StackOne, you don't need to disconnect and set up a new one. Reconnect that same account with your new Harvest V3 credentials. Your account ID and everything you've already configured stay exactly as they are, and your existing syncs keep running once you've reconnected. |
…ction section Adds the August 31, 2026 retirement date for Harvest v1 and v2 keys, renames the navigation icon to Settings, and removes the reconnection guidance in favour of one connect section that covers both cases.
jerann pushed a commit
that referenced
this pull request
Aug 12, 2026
) Exact-copy (single commit) of #398. Co-authored-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Greenhouse is retiring the Harvest v1 and v2 API keys on August 31, 2026, so the IAM guide now walks customers through Harvest V3 OAuth credentials instead of a single API key.
What changed
The old guide sent people to Dev Center to create a Harvest API key, pick the Custom partner type, and enable the User Roles and Users permissions. None of that applies on Harvest V3. The new flow is:
harvest:users:listandharvest:user_roles:listunder Manage Scopes, covering the Users and Roles resources listed in Available data.Every step, field label, and menu name matches the
greenhouseconnector's own config guide andconfigFieldsingreenhouseharvest3.connector.s1.yaml, so the Hub form and this page say the same thing.The connect section is written to cover both a first connection and a reconnection, since the fields are identical either way.
Also in this PR
harvestdocs.greenhouse.io/docs/authentication. The olddevelopers.greenhouse.io/harvest.htmllink documents the retiring API.<img className='rounded-md' ...>form used by the rest of the guides.Before you merge
images/greenhouse/image6.pngandimage7.pngare now unreferenced. Left in place in case anything outside this repo links to them.Testing
mintlify broken-linkspasses with no broken links. All three external links in the page return 200.