/bamboohr-data | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
bamboohr_data_create_webhook | Create Webhook |
bamboohr_data_delete_webhook | Delete Webhook |
bamboohr_data_get_field_options_v1_2 | Get Field Options (v1.2) |
bamboohr_data_get_fields_from_dataset_v1_2 | Get Fields from Dataset (v1.2) |
bamboohr_data_get_from_dataset_v2 | Get Data from Dataset (v2) |
bamboohr_data_get_post_fields | Get Webhook Post Fields |
bamboohr_data_get_report_by_id | Get Report by ID |
bamboohr_data_get_webhook | Get Webhook |
bamboohr_data_list_datasets_v1_2 | List Datasets (v1.2) |
bamboohr_data_list_monitor_fields | List Monitor Fields |
bamboohr_data_list_reports | List Reports |
bamboohr_data_list_webhook_logs | List Webhook Logs |
bamboohr_data_list_webhooks | List Webhooks |
bamboohr_data_update_webhook | Update Webhook |
bamboohr_data_create_webhook
Create Webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
events | string[] | No | — | Events 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. |
format | string | Yes | — | The payload format the webhook uses. Required. |
includeCompanyDomain | boolean | No | — | If set to true, the company domain will be added to the webhook request header. |
monitorFields | string[] | No | — | A 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. |
name | string | Yes | — | The name of the webhook. |
postFields | object | No | — | An 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. |
url | string | Yes | — | The url the webhook should send data to (must begin with https://). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"employee_with_fields.updated",
"employee_with_fields.created",
"employee_with_fields.deleted",
"company-integrations.updated",
"employee.created",
"employee.updated",
"employee.deleted",
"company.updated",
"company.deleted"
]
},
"description": "Events 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."
},
"format": {
"type": "string",
"description": "The payload format the webhook uses. Required.",
"enum": [
"json",
"form-encoded"
]
},
"includeCompanyDomain": {
"type": "boolean",
"description": "If set to true, the company domain will be added to the webhook request header."
},
"monitorFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A 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."
},
"name": {
"type": "string",
"description": "The name of the webhook."
},
"postFields": {
"type": "object",
"description": "An 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."
},
"url": {
"type": "string",
"description": "The url the webhook should send data to (must begin with https://)."
}
},
"required": [
"PCID",
"format",
"name",
"url"
]
}
bamboohr_data_delete_webhook
Delete Webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The webhook ID to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook ID to delete."
}
},
"required": [
"PCID",
"id"
]
}
bamboohr_data_get_field_options_v1_2
Get Field Options (v1.2) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
datasetName | string | Yes | — | The name of the dataset you want to see field options for. Use “List Datasets (v1.2)” to discover available dataset names. |
dependentFields | object | No | — | Dependent fields and their values that affect the options of the requested fields |
fields | string[] | Yes | — | List of field names to get options for |
filters | object | No | — | Optional 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"datasetName": {
"type": "string",
"description": "The name of the dataset you want to see field options for. Use \"List Datasets (v1.2)\" to discover available dataset names."
},
"dependentFields": {
"type": "object",
"description": "Dependent fields and their values that affect the options of the requested fields"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of field names to get options for"
},
"filters": {
"type": "object",
"description": "Optional 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."
}
},
"required": [
"PCID",
"datasetName",
"fields"
]
}
bamboohr_data_get_fields_from_dataset_v1_2
Get Fields from Dataset (v1.2) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
datasetName | string | Yes | — | The name of the dataset to retrieve fields for. Use “List Datasets (v1.2)” to discover valid names. |
page | integer | No | — | The page number to retrieve. Defaults to 1. |
page_size | integer | No | — | The number of records to retrieve per page. Defaults to 500. Maximum is 1000. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"datasetName": {
"type": "string",
"description": "The name of the dataset to retrieve fields for. Use \"List Datasets (v1.2)\" to discover valid names."
},
"page": {
"type": "integer",
"description": "The page number to retrieve. Defaults to 1."
},
"page_size": {
"type": "integer",
"description": "The number of records to retrieve per page. Defaults to 500. Maximum is 1000."
}
},
"required": [
"PCID",
"datasetName"
]
}
bamboohr_data_get_from_dataset_v2
Get Data from Dataset (v2) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
datasetName | string | Yes | — | The machine-readable name of the dataset to query. Use “List Datasets (v1.2)” to discover available names. |
fields | string[] | Yes | — | List of field names to return. Use “Get Fields from Dataset (v1.2)” to discover available names. |
filter | string | No | — | OData-style filter expression. Supported operators: eq, ne, lt, le, gt, ge, and, or, in. |
orderBy | string | No | — | Comma-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. |
page | integer | No | — | Page number to retrieve (1-indexed). Defaults to 1. |
pageSize | integer | No | — | Number of records per page. Defaults to 100. Maximum is 1000. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"datasetName": {
"type": "string",
"description": "The machine-readable name of the dataset to query. Use \"List Datasets (v1.2)\" to discover available names."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of field names to return. Use \"Get Fields from Dataset (v1.2)\" to discover available names."
},
"filter": {
"type": "string",
"description": "OData-style filter expression. Supported operators: eq, ne, lt, le, gt, ge, and, or, in."
},
"orderBy": {
"type": "string",
"description": "Comma-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."
},
"page": {
"type": "integer",
"description": "Page number to retrieve (1-indexed). Defaults to 1."
},
"pageSize": {
"type": "integer",
"description": "Number of records per page. Defaults to 100. Maximum is 1000."
}
},
"required": [
"PCID",
"datasetName",
"fields"
]
}
bamboohr_data_get_post_fields
Get Webhook Post FieldsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bamboohr_data_get_report_by_id
Get Report by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
reportId | integer | Yes | — | The numeric ID of the saved custom report to execute. |
page | integer | No | — | The page number to retrieve. Defaults to 1. |
page_size | integer | No | — | The number of records per page. Defaults to 500. Maximum is 1000. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"reportId": {
"type": "integer",
"description": "The numeric ID of the saved custom report to execute."
},
"page": {
"type": "integer",
"description": "The page number to retrieve. Defaults to 1."
},
"page_size": {
"type": "integer",
"description": "The number of records per page. Defaults to 500. Maximum is 1000."
}
},
"required": [
"PCID",
"reportId"
]
}
bamboohr_data_get_webhook
Get Webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The webhook ID to retrieve. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook ID to retrieve."
}
},
"required": [
"PCID",
"id"
]
}
bamboohr_data_list_datasets_v1_2
List Datasets (v1.2)Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bamboohr_data_list_monitor_fields
List Monitor FieldsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bamboohr_data_list_reports
List Reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1. |
page_size | integer | No | — | The number of records to retrieve per page. Defaults to 500. Maximum is 1000. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "The page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1."
},
"page_size": {
"type": "integer",
"description": "The number of records to retrieve per page. Defaults to 500. Maximum is 1000."
}
},
"required": [
"PCID"
]
}
bamboohr_data_list_webhook_logs
List Webhook Logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The webhook ID to get logs about. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook ID to get logs about."
}
},
"required": [
"PCID",
"id"
]
}
bamboohr_data_list_webhooks
List WebhooksShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bamboohr_data_update_webhook
Update Webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The webhook ID to update. |
events | string[] | No | — | Events 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. |
format | string | No | — | The payload format the webhook uses. Required. |
includeCompanyDomain | boolean | No | — | If set to true, the company domain will be added to the webhook request header. |
monitorFields | string[] | No | — | A 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. |
name | string | No | — | The name of the webhook. |
postFields | object | No | — | An 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. |
url | string | No | — | The url the webhook should send data to (must begin with https://). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook ID to update."
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"employee_with_fields.updated",
"employee_with_fields.created",
"employee_with_fields.deleted",
"company-integrations.updated",
"employee.created",
"employee.updated",
"employee.deleted",
"company.updated",
"company.deleted"
]
},
"description": "Events 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."
},
"format": {
"type": "string",
"description": "The payload format the webhook uses. Required.",
"enum": [
"json",
"form-encoded"
]
},
"includeCompanyDomain": {
"type": "boolean",
"description": "If set to true, the company domain will be added to the webhook request header."
},
"monitorFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A 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."
},
"name": {
"type": "string",
"description": "The name of the webhook."
},
"postFields": {
"type": "object",
"description": "An 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."
},
"url": {
"type": "string",
"description": "The url the webhook should send data to (must begin with https://)."
}
},
"required": [
"PCID",
"id"
]
}