Skip to main content

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.

1

Sign in to OysterHR

Sign in to your OysterHR account using the URL for your environment.

2

Navigate to Developer Portal

Navigate to the Developer section to create a new application.

  • In the sidebar, navigate to CompanyDeveloper.
  • Click Create new Developer Application.
3

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.
4

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.

5

Copy Authorization URL

After successful creation, the application will appear in the Applications table.

  • Find your application in the table and click the Copy button next to the Authorization URL.

Select Environment

In the StackOne connector profile, select the environment matching your Oyster HR account.

1

Choose your environment

Select the environment that corresponds to the Oyster HR account you signed into.

  • Select Production if you are connecting to a live Oyster HR account.
  • Select Sandbox if you are connecting to a sandbox account for testing.

Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for Oyster HR:
1

Navigate to Connector Profiles

Login to StackOne and navigate to Connector Profiles
2

Create New Connector Profile

  • Click + Connector Profile
  • Search for and select Oyster HR
  • Select Type as OAuth 2.0
  • Fill out the fields using details retrieved from your provider:
    • Client ID
    • Client Secret
    • Authorization URL
  • (Optional) Select Actions to be enabled for this Connector Profile
  • Click Create profile
Congratulations! The new Connector Profile will now show up in your project ready to be used. You can now continue to Link Accounts for Oyster HR.