Skip to main content
Select Actions to adjust the guide
Some actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.
Action
Scope(s)
Loading actions…
Dynamic Guide URL
Scopes Selected
Separator
​
Create a service account
Service accounts produce machine-readable credentials that identify your integration without using a real user account.
1
Sign in to HR Cloud
Sign in to your HR Cloud tenant using an account with the System Admin or HR Admin role. Only these roles can mint service-account credentials.
2
Open Service Accounts
Navigate to the Service Accounts page from System Settings.
  • Click the Settings gear in the top navigation.
  • Choose System Settings from the menu.
  • From the General section, select Service Accounts.
3
Add a new service account
On the Service Accounts page, click the + (Add) button to open the form.
  • Enter a descriptive title (for example StackOne integration).
  • Set status to Active.
  • Click Save.
4
Copy the KEY and SECRET values
Once saved, the KEY and SECRET columns become visible for the new service account. Copy both values — these become your Customer Key and Customer Secret. Store them securely for use later.
  • Note: HR Cloud may not display the secret again in plain text after this point in some tenant configurations.
  • To grant the service account access to specific objects, contact your HR Cloud Account Manager.


​
Optional: enable additional HR Cloud applications
HR Cloud is modular — some entities only become accessible after the relevant application is installed on the tenant. People, Onboard, and Offboard are installed by default and require no extra setup. The Time Off, Workmates, and Recruit applications must be requested from HR Cloud before their actions return data. Pick which ones you’ll use below, then follow the request steps.
1
Select the HR Cloud applications you need
Enables actions: Create Applicant, Create Employee Attachment, Create Time Off Request, Delete Employee Attachment, Download Employee Attachment(s), Get Applicant, Get Employee Attachment, List Applicant Statuses, List Applicants, List Employee Attachments, List Time Off Accruals, List Time Off Balances, List Time Off Requests, Update Applicant, Upload Applicant Resource (Resume / Cover Letter), Upsert Applicant, Upsert Time Off Request
Pick the applications that match the actions you plan to call. The remaining steps update to show only the configuration relevant to your selection.
2
Open Explore Apps
Enables actions: Create Applicant, Create Employee Attachment, Create Time Off Request, Delete Employee Attachment, Download Employee Attachment(s), Get Applicant, Get Employee Attachment, List Applicant Statuses, List Applicants, List Employee Attachments, List Time Off Accruals, List Time Off Balances, List Time Off Requests, Update Applicant, Upload Applicant Resource (Resume / Cover Letter), Upsert Applicant, Upsert Time Off Request
In the HR Cloud admin UI, click Explore Apps in the left navigation. Installed applications are listed under Your Apps; uninstalled ones are listed above with action buttons.
3
Request the application
Enables actions: Create Applicant, Create Employee Attachment, Create Time Off Request, Delete Employee Attachment, Download Employee Attachment(s), Get Applicant, Get Employee Attachment, List Applicant Statuses, List Applicants, List Employee Attachments, List Time Off Accruals, List Time Off Balances, List Time Off Requests, Update Applicant, Upload Applicant Resource (Resume / Cover Letter), Upsert Applicant, Upsert Time Off Request
Click I’M INTERESTED on the card for each application you selected. The card flips to REQUEST SENT while HR Cloud’s onboarding team provisions the app for your tenant. This is not instant — wait for the email confirmation before re-running the affected actions.
4
Verify the application is installed
Enables actions: Create Applicant, Create Employee Attachment, Create Time Off Request, Delete Employee Attachment, Download Employee Attachment(s), Get Applicant, Get Employee Attachment, List Applicant Statuses, List Applicants, List Employee Attachments, List Time Off Accruals, List Time Off Balances, List Time Off Requests, Update Applicant, Upload Applicant Resource (Resume / Cover Letter), Upsert Applicant, Upsert Time Off Request
Once provisioned, the application appears in the left navigation under Applications and under Your Apps on the Explore Apps page. Only then will the API entities tied to that application start returning 200 instead of 403.
5
Seed an applicant status record
Enables actions: Create Applicant, Get Applicant, List Applicant Statuses, List Applicants, Update Applicant, Upload Applicant Resource (Resume / Cover Letter), Upsert Applicant
Before calling create_applicant or upsert_applicant, open the Recruit module and create at least one xApplicantStatus record (for example Applied). Without a status record the applicant-status catalog is empty and write actions cannot supply a valid status Id.
6
Configure Time Off defaults
Enables actions: Create Time Off Request, List Time Off Accruals, List Time Off Balances, List Time Off Requests, Upsert Time Off Request
Review Settings → Holidays and Settings → Calendar to ensure default working days and hours are reasonable. Otherwise create_time_off_request may flag every date as a conflict.


​
Note: tasks tagged with the Benefits application
Calling create_task with applicationCode=benefits additionally requires the Benefits application to be installed on the tenant. Without it, the request returns Cannot find base portal for application code ‘benefits’. Benefits is requested through the same Explore Apps flow described above. Benefits is not modelled as a scope because create_task works without it for every other applicationCode.


​
Linking the Account from the Hub


1
Navigate to the Hub
Use one of the three Linking Account Methods to access the Hub.
2
Fill out the fields
Fill out the following fields using details from your provider:
  • Customer Key
  • Customer Secret
3
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

If the account linking is successful, you will see the newly linked account in your Accounts page.