Skip to main content
Access to client credentials is restricted. Contact api-support@oysterhr.com to have it enabled for your Oyster HR account before creating the application.

​
Create a Developer Application

Create an application in the Oyster Developer Portal to get the Client ID and Client Secret for the client credentials grant.

1

Create the application

Sign in to your Oyster HR account, then open Company > Developer.

  • Click Create application.
  • Name: StackOne Integration
  • Click Create to confirm.
2

Copy the credentials

Copy the Client ID and Client Secret into StackOne Hub.

3

Select the scopes

Enables actions: Approve Expense, Approve Time Off Request, Cancel Contract Change, Cancel Payroll Change, Confirm Time Sheet, Create Contract Change, Create Expense, Create Hiring Employment, Create Payroll Change, Create Time Off Request, Create Time Sheet, Create Time Sheet Entry, Decline Expense, Delete Expense, Delete Hiring Employment, Delete Time Sheet, Delete Time Sheet Entry, Delete Webhook, Get Bank Account, Get Company, Get Contract Change, Get Default Payroll Changes Ruleset, Get Default Payroll Changes Source Types, Get Engagement, Get Expense, Get Hiring Employment, Get Hiring Employment Tasks, Get Payroll Change, Get Payroll Changes Ruleset, Get Payroll Changes Source Types, Get Payroll Item, Get Time Off Entitlement, Get Time Off Request, Get Time Sheet, Invite Team Member, List Bank Accounts, List Contract Changes, List Departments, List Engagement Allowances, List Engagement Bonuses, List Engagement Documents, List Engagement Payslips, List Engagements, List Expenses, List Payroll, List Payroll Changes, List Payroll Records, List Time Off Entitlements, List Time Off Requests, List Time Sheets, List Webhook Dispatches, List Webhooks, Reject Time Off Request, Submit Hiring Employment, Submit Time Sheet, Update Hiring Employment, Update Payroll Change, Update Personal Details, Update Time Sheet Entry

Oyster HR grants three scopes to a client-credentials application. Select the ones the actions you plan to use require.

4

Choose the environment

Select the environment that matches the Oyster HR account the application belongs to.

  • Select Production for a live Oyster HR account.
  • Select Sandbox for a sandbox account used for testing.
5

Set the acting administrator

Some Oyster HR endpoints record who performed an action. A client-credentials connection has no signed-in user, so those calls are attributed to an administrator you nominate.

  • Actor Email: the email address of an Oyster HR user with the Administrator role.
  • Creating expenses, contract changes and hiring employments, approving or declining expenses, submitting an employment, and inviting a team member all run as this user.
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.