Skip to main content
Server path: /bamboohr-data | Type: Application | PCID required: Yes

Tools


bamboohr_data_create_webhook

Create Webhook Parameters:
ParameterTypeRequiredDefaultDescription
eventsstring[]NoEvents that trigger this webhook. Defaults to [‘employee_with_fields.updated’, ‘employee_with_fields.deleted’, ‘employee_with_fields.created’] if not specified. Cannot mix employee_with_fields events with employee events.
formatstringYesThe payload format the webhook uses. Required.
includeCompanyDomainbooleanNoIf set to true, the company domain will be added to the webhook request header.
monitorFieldsstring[]NoA list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee_with_fields.updated or employee.updated.
namestringYesThe name of the webhook.
postFieldsobjectNoAn object map of field ID or alias to the external name used in the webhook payload (e.g. {"firstName": "First Name"}). Omit or send an empty object to include no extra fields.
urlstringYesThe url the webhook should send data to (must begin with https://).

bamboohr_data_delete_webhook

Delete Webhook Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe webhook ID to delete.

bamboohr_data_get_field_options_v1_2

Get Field Options (v1.2) Parameters:
ParameterTypeRequiredDefaultDescription
datasetNamestringYesThe name of the dataset you want to see field options for. Use “List Datasets (v1.2)” to discover available dataset names.
dependentFieldsobjectNoDependent fields and their values that affect the options of the requested fields
fieldsstring[]YesList of field names to get options for
filtersobjectNoOptional filters to apply when retrieving field options. Filters limit the returned options based on other field values. The object contains a match key (all or any) and a filters array of objects with field, operator, and value keys.

bamboohr_data_get_fields_from_dataset_v1_2

Get Fields from Dataset (v1.2) Parameters:
ParameterTypeRequiredDefaultDescription
datasetNamestringYesThe name of the dataset to retrieve fields for. Use “List Datasets (v1.2)” to discover valid names.
pageintegerNoThe page number to retrieve. Defaults to 1.
page_sizeintegerNoThe number of records to retrieve per page. Defaults to 500. Maximum is 1000.

bamboohr_data_get_from_dataset_v2

Get Data from Dataset (v2) Parameters:
ParameterTypeRequiredDefaultDescription
datasetNamestringYesThe machine-readable name of the dataset to query. Use “List Datasets (v1.2)” to discover available names.
fieldsstring[]YesList of field names to return. Use “Get Fields from Dataset (v1.2)” to discover available names.
filterstringNoOData-style filter expression. Supported operators: eq, ne, lt, le, gt, ge, and, or, in.
orderBystringNoComma-separated sort rules. Each rule is a field name followed by a direction (asc or desc). Sorted fields must also appear in the fields array.
pageintegerNoPage number to retrieve (1-indexed). Defaults to 1.
pageSizeintegerNoNumber of records per page. Defaults to 100. Maximum is 1000.

bamboohr_data_get_post_fields

Get Webhook Post Fields

bamboohr_data_get_report_by_id

Get Report by ID Parameters:
ParameterTypeRequiredDefaultDescription
reportIdintegerYesThe numeric ID of the saved custom report to execute.
pageintegerNoThe page number to retrieve. Defaults to 1.
page_sizeintegerNoThe number of records per page. Defaults to 500. Maximum is 1000.

bamboohr_data_get_webhook

Get Webhook Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe webhook ID to retrieve.

bamboohr_data_list_datasets_v1_2

List Datasets (v1.2)

bamboohr_data_list_monitor_fields

List Monitor Fields

bamboohr_data_list_reports

List Reports Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1.
page_sizeintegerNoThe number of records to retrieve per page. Defaults to 500. Maximum is 1000.

bamboohr_data_list_webhook_logs

List Webhook Logs Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe webhook ID to get logs about.

bamboohr_data_list_webhooks

List Webhooks

bamboohr_data_update_webhook

Update Webhook Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe webhook ID to update.
eventsstring[]NoEvents that trigger this webhook. Defaults to [‘employee_with_fields.updated’, ‘employee_with_fields.deleted’, ‘employee_with_fields.created’] if not specified. Cannot mix employee_with_fields events with employee events.
formatstringNoThe payload format the webhook uses. Required.
includeCompanyDomainbooleanNoIf set to true, the company domain will be added to the webhook request header.
monitorFieldsstring[]NoA list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee_with_fields.updated or employee.updated.
namestringNoThe name of the webhook.
postFieldsobjectNoAn object map of field ID or alias to the external name used in the webhook payload (e.g. {"firstName": "First Name"}). Omit or send an empty object to include no extra fields.
urlstringNoThe url the webhook should send data to (must begin with https://).