BambooHR v2

Provides integration with BambooHR, a human resources platform used to manage employee records, datasets, and time-off information through people and HR APIs.

The Flowgear BambooHR Node lets you query the supported BambooHR read surface and execute create and update operations through curated templates in a Workflow.

Revision History

0.0.0.1 - Initial release.
0.0.0.2 - Improved employee query field handling and plain-text BambooHR error normalization.
0.0.0.3 - Removed generic Public API wording from template names and expanded Create and Update templates across the broader supported BambooHR write surface.
0.0.0.4 - Maintenance release.
0.0.0.5 - Added the BambooHR Node logo.
0.0.0.6 - Maintenance release.
0.0.0.7 - Aligned the Runtime connector contract.
0.1.0.0 - Completed the Runtime overhaul with eager first-request startup and lazy continuation.
0.1.0.1 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.1.0.3 - Updated Runtime compatibility.

Connection

Use this Connection to store the BambooHR tenant and API key used by all Node methods.

Property Type Description
Company Domain String Required. BambooHR tenant subdomain only. Enter the subdomain without https:// and without .bamboohr.com.
API Key Masked Required. BambooHR API key used for HTTP Basic authentication.
Timeout (seconds) Integer Request timeout used for Connection validation and Node requests. Must be greater than zero. The default is 30.

Setup Notes

  • Create or identify a BambooHR API key with permission to read and change the employee, dataset, and time-off data you plan to use.
  • Enter Company Domain as the BambooHR tenant subdomain only. For example, use contoso instead of https://contoso.bamboohr.com. Values that contain ://, /, or .bamboohr.com are rejected.
  • The BambooHR Node supports API-key authentication only. OAuth is not supported.
  • The Connection test calls BambooHR's field metadata endpoint to verify the Company Domain and API Key.

Methods

The Node exposes separate methods for read, create, and update actions while keeping the supported BambooHR surface curated.

Query

Reads BambooHR metadata, employee records, dataset information, dataset query results, and time-off information.

Parameter Type Description
Connection Connection BambooHR Connection details.
OperationId String Template-selected BambooHR operation identifier.
Options Object Route and query values required by the selected operation.
Items Array Optional structured request body used by query operations that require a JSON body, such as dataset field-options and dataset data requests.
Return Type Description
Response Array Returns BambooHR business rows for the selected query operation. Query rows do not include the Flowgear mutation metadata.

Create

Creates BambooHR resources across the supported BambooHR write surface. This includes operations such as employee creation, photo and file-style uploads where BambooHR models them directly, time-off creation, and other non-deprecated BambooHR create operations.

Parameter Type Description
Connection Connection BambooHR Connection details.
OperationId String Template-selected BambooHR operation identifier.
Options Object Route and query values required by the selected operation.
Items Array Structured request body for the selected create operation.
Return Type Description
Response Array Returns BambooHR response fields together with the Flowgear object, which contains IsSuccess, Message, and the Request that was sent.

Update

Updates BambooHR resources across the supported BambooHR write surface. This includes operations such as employee updates, time-off status changes, and other non-deprecated BambooHR update operations.

Parameter Type Description
Connection Connection BambooHR Connection details.
OperationId String Template-selected BambooHR operation identifier.
Options Object Route and query values required by the selected operation.
Items Array Structured request body for the selected update operation.
Return Type Description
Response Array Returns BambooHR response fields together with the Flowgear object, which contains IsSuccess, Message, and the Request that was sent.

Usage Notes

  • Query operations complete the first BambooHR page while the Node invoke is awaited. Additional pages are fetched only as the Workflow consumes the response stream.
  • Create and Update complete the first input item while the Node invoke is awaited. Later items are consumed lazily, and an empty connected input sends no request to BambooHR.
  • The supported Query surface includes field and table metadata, employee reads, employee table rows, changed-employee sync endpoints, dataset discovery, dataset field discovery, dataset field-options lookup, dataset data queries, time-off types and policies, time-off requests, who's out, and time-off balance calculations.
  • Template names hide BambooHR's generic Public API tag so designers see the business-facing operation name only.
  • The Node handles supported BambooHR paging internally. Workflow designers do not need to pass paging controls for employee-list, dataset-field, or dataset-query operations.
  • Employee-list field selections can be supplied as an array in the designer. The Node converts them into BambooHR's documented comma-separated query format at runtime.
  • Dataset query responses keep returned values nested under fields instead of flattening dynamic dataset columns into the top-level row.
  • Employee list rows preserve BambooHR paging metadata such as meta and _links, and time-off type rows preserve defaultHours for downstream logic.
  • If a Query call to BambooHR fails, the Node surfaces the BambooHR error instead of converting it into an empty result.
  • Create and Update rows report the outcome through the Flowgear object instead of top-level status, statusMessage, and errorMessage fields. When BambooHR returns a plain-text error, the text is preserved in providerText.
  • Query-style dataset POST operations remain under the Query method even though BambooHR models them as POST, because they retrieve data rather than change records.

Known Issues

  • OAuth authentication is not supported. The Node supports BambooHR API-key authentication only.
  • Query exposes only the curated read operations listed in Usage Notes. Other BambooHR read operations, such as the employee directory, deprecated custom reports, and webhook listings, are not available.
  • Create and Update exclude deprecated BambooHR operations and operations that use the HTTP DELETE method.