BambooHR

Any instance where an entry in the below configuration has a leading $ represents a parameter that needs to be replaced with a static value.

Parameters in this document:

• $endpoint - The endpoint that you would like to ingest into Panoply. Details of the value that should be used here can be found in the API Resources section below.
• $sub_domain - Per BambooHR API documentation, "If you access BambooHR at https://mycompany.bamboohr.com, then the sub_domain is "mycompany".
• $base_url - The API Base URL will follow the below format:
  • https://api.bamboohr.com/api/gateway.php/$sub_domain/$endpoint
• $api_key - Per BambooHR API documentation here, to generate an API key, users should log in and click their name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient permissions, there will be an "API Keys" option in that menu to go to the page.
• $resource_name - The resource that you would like to ingest into Panoply. Details of the value that should be used here can be found in the API Resources section below.
• $data_key - The location of the data in the API response
• $report_id - This parameter only applies to the Reports API Resource, and represents the id of the report that is being ingested into Panoply. This ID can be found in the URL of the report on the BambooHR platform.

For the Aggregate Goal Info, Employee Files and Categories, Employee Goals, Employee Trainings, and Goal Status Counts resources listed above, you will need to include the Fetch List configuration (see below).

Destination Table naming convention is ultimately up to you as the data owner. A common structure used for this API is to utilize the resource name within the table name. It is suggested to switch spaces with _ in the destination configuraiton. For example, if collecting the Applications resource, using a name like bamboohr_applications.

Per BambooHR documentation, "Use the secret key as the username and any random string for the password." Per this statement, you can put any string as the password as part of this configuration. Within the BambooHR documentation, they use a value of "x", though any string will work.

Only applicable for the Aggregate Goal Info, Employee Files and Categories, Employee Goals, Employee Trainings, and Goal Status Counts resources

For the Reports resource, a Primary Key may need to be defined, depending on the data within the given report. For example, if the unique identifier for a given Report is "Date-EmployeeID", the Primary Key will need to be set to {date}-{employeeid}.