When you add a SmartHR card to a flow for the first time, Okta Workflows prompts you to configure a connection to your SmartHR tenant account. This connection enables you to connect your SmartHR account, save your account information, and reuse the connection for any new flows that include SmartHR.

You can create multiple unique connections and manage them from the Connections page in the Okta Workflows Console.

Before you begin

You need several pieces of information from your SmartHR account:

  • Your account type. After you sign in to your SmartHR account, you can determine your account type based on the URL shown in your browser.

    • If the URL begins with https://{tentant_id}, choose a Sandbox account.

    • If the URL begins with https://{tentant_id}, choose a Production account.

  • The tenant ID. The tenant ID is the first part of the URL shown in your browser when signed in to your SmartHR account.

  • An access token. Go to Personal SettingsExternal System LinkageAPI LinkageAccess token to find or create an access token for your SmartHR account.

Permissions required

Assign the following minimum permissions to your SmartHR access token to use the SmartHR connector:


Permission required

/api/v1/users Read
/api/v1/crews Read, Write
/api/v1/biz_establishments Read
/api/v1/employment_types Read
/api/v1/departments Read
/api/v1/job_titles Read
/api/v1/crew_custom_field_template Read

Start this task

To create a SmartHR connection in Okta Workflows:

  1. Open the Connections tab in the Workflows Console or open a SmartHR card.

  2. Click New Connection.

  3. Enter a Connection Nickname. This is useful if you plan to create multiple connections to share with your team.

  4. In the Account Type field, select the matching account type for your SmartHR account, either Sandbox or Production.

  5. Enter the Tenant ID for your account.

  6. Enter your SmartHR access token in the Access Token field.

  7. Click Create.

  8. If prompted, click Allow to grant access to your SmartHR data.

Related topics

SmartHR connector

Workflow elements

SmartHR API documentation