Overview
This article explains how to configure the Incydr Flow for Bamboo HR, which automates Incydr watchlist management. Specifically, the Bamboo HR Flow:
- Automatically adds users to Incydr's Departing Employee watchlist based on their termination date in Bamboo HR.
- (Optional) Automatically adds users to Incydr's New Hire watchlist based on their hire date in Bamboo HR.
The steps below cover how to create a report in Bamboo HR, generate a Bamboo HR API key, create an Incydr API client, and define the required properties in the Incydr console.
Considerations
- You must be licensed for the Bamboo HR Flow to complete the steps below. Contact your Customer Value Manager (CVM) if you have questions about licensing.
Step 1: Bamboo HR configuration
Work with your Bamboo HR administrator to complete the steps below for departing and new hire employees.
Departing employees
- In Bamboo HR, create a report that includes these columns:
- Work Email
- Termination Date
- Filter the report to include only the employees you want to target. For example, filter for a termination date later than today.
Without a filter, the report returns all employees. - Record the report ID.
The report ID is required in the steps below to enable the Flow in the Incydr console. -
Use the following curl command to confirm the report returns the correct users and termination dates:
curl -X GET -u '<<API key>>:x' https://api.bamboohr.com/api/gateway.php/<<company domain>>/v1/reports/<<report id>>?onlyCurrent=false&format=json - In Bamboo HR, select your name in the menu at the top right, then select API Keys.
- Enter an API key name, then click Generate Key.
Bamboo HR generates the API key. - Save the API key in a secure location for future reference.
The API key is required to initially enable the Flow in the Incydr console, as well as to update settings after the initial setup.
New hire employees (optional)
To automatically add users to Incydr's New Hire watchlist:
- In Bamboo HR, create a second report that includes these columns:
- Work Email
- Hire Date
- Filter the report to include only the employees you want to target. For example, filter for a hire date within the past 90 days.
- Record the report ID.
The report ID is required in the steps below to enable the Flow in the Incydr console.
Step 2: Incydr configuration
API client setup
Create a new Incydr API client:
- Sign in to the Incydr console.
- Go to Administration > Integrations > API Clients.
- Select Create new API client.
- Enter a name specific to this flow (for example, "Bamboo HR watchlist management").
- Add these permissions:
- Detection lists - Read and Write
- User - Read
- Save the Client ID, Secret, and Base URL in a secure location for future reference.
The Incydr API client credentials are required to initially enable the Flow in the Incydr console, as well as to update settings after the initial setup.
Bamboo HR Flow setup
- In the Incydr console, go to Administration > Integrations > Incydr Flows.
- From the list of Flows, select the Bamboo HR watchlist management flow.
- Complete these fields:
- Bamboo HR company domain: Enter your organization's Bamboo HR company domain.
- Bamboo HR Departing Employee report ID: Enter the report ID for the departing employee report you created above in step 1.
- Bamboo HR New Hire report ID: (Optional) Enter the report ID for the new hire report you created above in step 1.
- Bamboo HR API key: Enter the API key you generated above in step 1.
- Code42 API client ID: Enter the Incydr API Client ID obtained in step 2 above.
- Code42 API client secret: Enter the Incydr API Secret obtained in step 2 above.
- Code42 base URL: Enter the Base URL obtained in step 2 above. You can also obtain the Base URL by identifying the URL for your Incydr cloud environment.
- Recipient email address for error report: Specify an email address to receive reports when a Bamboo HR user does not have a matching user in Incydr. Reports are sent once per the scheduled interval defined below.
- Scheduled interval in minutes: Select how often to run the Flow and process changes.
- Click Submit.
Comments
Please sign in to leave a comment.