Create an Oyster Developer App
Create a Developer App in the Oyster Developer Portal to obtain your OAuth credentials. Create the app from the same environment (Production or Sandbox) you intend to use in StackOne.
Sign in to OysterHR
Sign in to your OysterHR account using the URL for your environment.
- For the Production environment, sign in at https://app.oysterhr.com.
- For the Sandbox environment, sign in at https://sandbox.oysterhr.com/users/sign_in.
Navigate to Developer Portal
Navigate to the Developer section to create a new application.
- In the sidebar, navigate to Company → Developer.
- Click Create new Developer Application.
Create a new Developer App
Fill in the application details. The Name field is required to create the application successfully.
- Enter a Name (e.g., StackOne Integration).
- Optionally enter a Description.
- Set the Redirect URL to
https://api.stackone.com/connect/oauth2/oysterhr/callback. - Under Permissions, select the permissions required for your integration.
- ⚠️ Important: The first permission — Read all information on the Oyster Platform — is mandatorily required in order to connect the account successfully.
- Accept the Developer Terms of Service.
- Click Submit.
Copy Client ID and Client Secret
After clicking Save, the Client ID and Client Secret will be shown in the dialog. Store them securely as they won’t be shown again.
Select Environment
In the StackOne connector profile, select the environment matching your Oyster HR account.
Creating the StackOne Connector Profile
To create the Connector Profile in StackOne for Oyster HR:Navigate to Connector Profiles