V2NodesBambooHR
BambooHR
V2

BambooHR

BambooHR is 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 the current create and update operations through curated templates in a Workflow.

Revision History

0.1.0.1 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.1.0.0 - Completed the V2 overhaul with eager first-request startup and lazy continuation.
0.0.0.7 - Aligned the V2 connector contract and public help article.
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 - Published the latest validated BambooHR connector package version.
0.0.0.5 - Added the BambooHR Node logo asset to the package.
0.0.0.6 - Published the latest BambooHR connector package version after the most recent node update.

Connection

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

Property Type Description
Company Domain String BambooHR tenant subdomain only. Enter the subdomain without https:// and without .bamboohr.com.
API Key Masked BambooHR API key used for HTTP Basic authentication in the current curated surface.
Timeout (seconds) Integer Request timeout used for Connection validation and Node requests.

Setup Notes

  • Create or identify a BambooHR API key with permission to read 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.
  • The current BambooHR Node uses API-key authentication only. OAuth is not part of this first release.
  • Connection validation calls a low-risk BambooHR metadata endpoint before Workflow execution continues.

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 mutation-style default fields.

Create

Creates BambooHR resources across the broader supported BambooHR write surface exposed by the embedded OpenAPI document. This includes operations such as employee creation, photo and file-style uploads where BambooHR models them directly, time-off creation, and other non-deprecated provider create routes that fit the node's Create method.

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 provider payload fields together with the Flowgear Flowgear.IsSuccess and Flowgear.Message mutation defaults.

Update

Updates BambooHR resources across the broader supported BambooHR write surface exposed by the embedded OpenAPI document. This includes operations such as employee updates, time-off status changes, and other non-deprecated provider update routes that fit the node's Update method.

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 provider payload fields together with the Flowgear Flowgear.IsSuccess and Flowgear.Message mutation defaults.

Usage Notes

  • Query operations complete the first provider 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 provider request.
  • The supported Query surface includes employee field metadata, employee reads, changed-employee sync endpoints, dataset discovery, dataset field discovery, dataset field-options lookup, dataset data queries, time-off lookup data, time-off requests, and time-off balance queries.
  • Template names intentionally 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 transport paging controls for employee-list 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.
  • Query rows stay focused on the BambooHR business payload and do not add mutation-style default fields.
  • Dataset query responses keep returned values nested under fields instead of flattening dynamic dataset columns into the top-level row.
  • Employee list rows preserve provider paging metadata such as meta and _links, and time-off type rows preserve defaultHours for downstream logic.
  • If the first provider query call fails, the Node surfaces that BambooHR error instead of converting it into an empty result.
  • Create and Update rows use the Flowgear mutation defaults through the Flowgear object instead of the older top-level status, statusMessage, and errorMessage fields.
  • Query-style dataset POST operations remain under the Query method even though BambooHR models them as POST, because they retrieve data rather than mutate records.

Known Issues

  • OAuth authentication is intentionally deferred. This release supports BambooHR API-key authentication only.
  • The Node still hides BambooHR families that are not part of the supported Flowgear surface, including employee directory, deprecated custom reports, webhook endpoints, and delete-style operations.