Configuring the BambooHR Action¶
The XO Platform lets you easily connect the HubSpot integration to create, view, and update employees. You can also search and view time off requests, who is out and update request status using the pre-built templates.
This document explains how to enable, authorize, configure, and install the BambooHR pre built templates.
Authorizations Supported¶
The Kore.ai XO Platform supports basic authentication to allow BambooHR integration to exchange data. For more information, read the Bot Authorization Overview article.
The Kore.ai XO Platform supports the following authorization types for the BambooHR integration:
- Pre-Authorize the Integration – To make the integration process smoother for developers and customers, you can pre-authorize it by providing the necessary authorization credentials to obtain the access token.
- Allow Users to Authorize the Integration – This method requires the end user to provide credentials during the conversation for authorization. This authorization process involves requesting permission for Kore.ai’s BambooHR app to access an access token at runtime. To learn more about BambooHR account types, see BambooHR documentation.
Step 1: Enable the BambooHR Action¶
Prerequisites:
Before enabling the BambooHR action, complete the following prerequisites:
- If you don’t have BambooHR account credentials, create a developer account in BambooHR and note down login credentials. Use the BambooHR Documentation for more information.
- Copy the user sub domain and API key values and keep them for future use to enable the integration.
Steps to enable the BambooHR action:
- Go to App Settings > Integrations > Actions.
- Select the BambooHR action.
Pre-authorize the Integration¶
Basic Auth
You can authorize the integration using your credentials. The developer authorization lets you authorize the integration with preconfigured Kore.ai’s app with the Basic Auth option.
Steps to authorize a BambooHR action using developer credentials:
- Go to App Settings > Integrations > Actions.
- Select the BambooHR action in the Available Actions region.
- In the Configurations dialog, select the Authorization tab.
-
Enter the following details:
-
Click Enable. When you configure the action for the first time, the Integration Successful pop-up is displayed.
Note
You will notice the BambooHR action is moved from Available to Configured region.
Allow End User to Authorize¶
You can authorize the integration at a user level with their login credentials. The user authorization process involves requesting permission for Kore.ai’s BambooHR app to access an access token at runtime. You can also use the basic auth profile to let a user configure the integration at runtime.
Steps to authorize a BambooHR action at a user level:
- Go to App Settings > Integrations > Actions.
- Select the BambooHR action in the Available Actions region.
- In the Configurations dialog, select the Authorization tab.
-
Enter the following details:
- Authorization Type – Select the Allow Users to Authorize the Integration option, and then select the Basic Auth option.
- Create your authorization profile to obtain an access token and use it to complete integration without using Kore.ai’s BambooHR app for authorization.
- Click the Select Authorization drop-down and select the Create New option.
- Select the type of authorization mechanism. For example, select the Basic Auth option. To create Basic Auth profiles, see Bot Authorization Overview.
- Authorization Type – Select the Allow Users to Authorize the Integration option, and then select the Basic Auth option.
-
Enter the following authentication credentials for the Basic Auth mechanism:
- Name – Enter the name for the Basic Auth profile.
- Select Yes; some tasks will have tenancy URLs, and the user must provide the URLs to successfully authenticate.
- Base URL – Enter the base tenant URL for the BambooHR instance.
- Authorization Check URL – Enter the authorization check URL for your BambooHR instance.
- Description – Enter the description of the basic authentication profile.
-
Click Save Auth to save the authorization profile.
-
Select the new Authorization Profile, which you created to complete integration.
-
Click Enable. When you configure the action for the first time, the Integration Successful pop-up is displayed.
Step 2: Install the BambooHR Action Templates¶
Once you have configured a BambooHR integration, you can explore and install action templates.
Steps to install action templates:
-
On the Integration Successful dialog, click the Explore Templates button to view the templates.
-
In the Integration Templates dialog, click the Install button to begin the installation.
-
Once the template is installed, the associated dialog task is auto-created and displayed on the Dialogs page. Click Go to Dialog or go to Automation AI > Virtual Assistant > Use Cases > Dialogs.
-
To start using the templates, see Using BambooHR Action Templates.