Skip to main content
System or HR Admin role is required to access System Settings > Service Accounts. If the menu is not visible, ask your HR Cloud Account Manager to grant the required permissions.

Create a service account

Service accounts produce machine-readable credentials that identify your integration without using a real user account.

1

Add a new service account

Sign in to your HR Cloud tenant.

  • Click the Settings gear in the top navigation.
  • Open System Settings > General > Service Accounts.
  • Click the + (Add) button.
  • Title: A name that identifies this integration
  • Status: Active
  • Click Save.
2

Copy the KEY and SECRET values

Once saved, the KEY and SECRET columns become visible for the new service account.

  • Copy the KEY across as the Customer Key.
  • Copy the SECRET across as the Customer Secret.
  • 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.

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.

1

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

In the HR Cloud admin UI, open Explore Apps in the left navigation. Installed applications are listed under Your Apps. Uninstalled ones show action buttons.

Click I’M INTERESTED on the card for each application listed. The card flips to REQUEST SENT while HR Cloud’s onboarding team provisions the app for your tenant. This is not instant, so wait for the email confirmation.

Once installed, the application appears under Applications in the left navigation and under Your Apps on the Explore Apps page.

2

Create 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

Open the Recruit application and create at least one xApplicantStatus record (for example Applied).

3

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

Set the tenant’s default working days and hours.

  • Open Settings > Holidays and review the defaults.
  • Open Settings > Calendar and review the defaults.
4

Request the Benefits application (optional)

Create Task needs the HR Cloud Benefits application to create tasks for Benefits.

  • In Explore Apps, click I’M INTERESTED on the Benefits card.
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.