> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HiBob

> How to set up the HiBob connector, plus the actions and events that are available.

![HiBob](https://stackone-logos.com/api/hibob/filled/svg)

Previewv4.0.4[See changelog](https://docs.stackone.com/connectors/hibob/changelog.md)

[129 actions](#actions) · [28 events](#events) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Service User · Connector Profile](https://docs.stackone.com/connectors/hibob/guides/connector-profile/service-user.md)
>
> No app registration required. Access is limited to the permissions group the Service User belongs to.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/hibob/guides/connector-profile/oauth-2-0.md)
>
> Connect your HiBob account using OAuth 2.0. You will be redirected to HiBob to authorize access and select which employe...

Optionally, configure receiving Events for HiBob into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/hibob/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Service User · Link Account](https://docs.stackone.com/connectors/hibob/guides/link-account/service-user.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/hibob/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

Service User

No auth methods found

Scopes

Select all
|
Clear

attendance:write

company.metadata:read

company.metadata:write

documents:read

documents:write

employee\_data.history:read

employee\_data.sensitive.history:read

employee\_data.sensitive.history:write

employee\_data.sensitive:read

employee\_data.sensitive:write

employee\_data:read

employee\_data:write

goals:write

hiring:write

job\_catalog:read

reports:read

tasks:write

timeoff:read

timeoff:write

workforce\_planning:read

workforce\_planning:write

No scopes found

129 actions

ActionDescriptionRequired scopes

Get Document Folders Metadata`hibob_get_document_folders_metadata`

Get metadata for all document folders

`documents:read`

List Employee Documents`hibob_list_employee_documents`

Get list of documents for an employee

`documents:read`

Upload Document From URL To Shared Folder`hibob_upload_document_from_url_to_shared`

Upload a file from a Public URL to an employee's shared folder

`documents:write`

Upload File To Shared Folder`hibob_upload_file_to_shared_folder`

Upload a file directly to an employee's shared folder

`documents:write`

Upload Document From URL To Confidential Folder`hibob_upload_document_from_url_to_confidential`

Upload a file from a Public URL to an employee's confidential folder

`documents:write`

Upload File To Confidential Folder`hibob_upload_file_to_confidential_folder`

Upload a file directly to an employee's confidential folder

`documents:write`

Delete Document From Shared Folder`hibob_delete_document_from_shared_folder`

Delete a document from an employee's shared folder

`documents:write`

Delete Document From Confidential Folder`hibob_delete_document_from_confidential_folder`

Delete a document from an employee's confidential folder

`documents:write`

Upload Document From URL To Custom Folder`hibob_upload_document_from_url_to_custom_folder`

Upload a file from a Public URL to an employee's custom folder

`documents:write`

Upload File To Custom Folder`hibob_upload_file_to_custom_folder`

Upload a file directly to an employee's custom folder

`documents:write`

Delete Document From Custom Folder`hibob_delete_document_from_custom_folder`

Delete a document from an employee's custom folder

`documents:write`

List Employee Work History`hibob_list_employee_work_history`

Get work history for an employee

`employee_data:read`

Create Work History Entry`hibob_create_work_history_entry`

Create a new work history entry for an employee

`employee_data:write`

Update Work History Entry`hibob_update_work_history_entry`

Update an existing work history entry

`employee_data:write`

Delete Work History Entry`hibob_delete_work_history_entry`

Delete a work history entry

`employee_data:write`

List Employee Employment History`hibob_list_employee_employment_history`

Get employment history for an employee

`employee_data:read`

Create Employment History Entry`hibob_create_employment_history_entry`

Create a new employment history entry

`employee_data:write`

List Employee Lifecycle History`hibob_list_employee_lifecycle_history`

Get lifecycle status history for an employee

`employee_data:read`

List Employee Salary History`hibob_list_employee_salary_history`

Get salary history for an employee

`employee_data.sensitive:read`

Create Salary Entry`hibob_create_salary_entry`

Create a new salary entry for an employee

`employee_data.sensitive:write`

List Employee Training Records`hibob_list_employee_training_records`

Get training records for an employee

`employee_data:read`

Create Training Record`hibob_create_training_record`

Create a new training record for an employee

`employee_data:write`

Delete Training Record`hibob_delete_training_record`

Delete a training record for an employee

`employee_data:write`

Update Employment History Entry`hibob_update_employment_entry`

Update an existing employment history entry

`employee_data:write`

Delete Employment History Entry`hibob_delete_employment_entry`

Delete an employment history entry

`employee_data:write`

Delete Salary Entry`hibob_delete_salary_entry`

Delete a salary entry from an employee's salary history

`employee_data.sensitive:write`

List Employee Equity Grants`hibob_list_employee_equity_grants`

Get equity grants for an employee

`employee_data.sensitive:read`

Create Equity Grant`hibob_create_equity_grant`

Create a new equity grant for an employee

`employee_data.sensitive:write`

Update Equity Grant`hibob_update_equity_grant`

Update an existing equity grant for an employee

`employee_data.sensitive:write`

Delete Equity Grant`hibob_delete_equity_grant`

Delete an equity grant for an employee

`employee_data.sensitive:write`

List Employee Variable Payments`hibob_list_employee_variable_payments`

Get variable payment records for an employee

`employee_data.sensitive:read`

Create Variable Payment`hibob_create_variable_payment`

Create a new variable payment record for an employee

`employee_data.sensitive:write`

Delete Variable Payment`hibob_delete_variable_payment`

Delete a variable payment record for an employee

`employee_data.sensitive:write`

List Employee Bank Accounts`hibob_list_employee_bank_accounts`

Get bank account information for an employee

`employee_data.sensitive:read`

Create Bank Account`hibob_create_bank_account`

Create a new bank account entry for an employee

`employee_data.sensitive:write`

Update Bank Account`hibob_update_bank_account`

Update an existing bank account entry

`employee_data.sensitive:write`

Delete Bank Account`hibob_delete_bank_account`

Delete a bank account entry for an employee

`employee_data.sensitive:write`

List Bulk Work History`hibob_list_bulk_work_history`

Get work history for multiple employees

`employee_data.history:read`

List Bulk Lifecycle History`hibob_list_bulk_lifecycle_history`

Get lifecycle history for multiple employees

`employee_data.history:read`

List Bulk Employment History`hibob_list_bulk_employment_history`

Get employment history for multiple employees

`employee_data.history:read`

List Bulk Salaries History`hibob_list_bulk_salaries_history`

Get salary history for multiple employees

`employee_data.sensitive.history:read`

List Bulk Dependents History`hibob_list_bulk_dependents_history`

Get dependents history for multiple employees

`employee_data.history:read`

List Bulk Equities History`hibob_list_bulk_equities_history`

Get equity grants history for multiple employees

`employee_data.sensitive.history:read`

List Bulk Variable Payments History`hibob_list_bulk_variable_history`

Get variable payment history for multiple employees

`employee_data.sensitive.history:read`

List Bulk Entitlement History`hibob_list_bulk_entitlement_history`

Get entitlement history for multiple employees

`employee_data.sensitive.history:read`

List Bulk Deduction History`hibob_list_bulk_deduction_history`

Get deduction history for multiple employees

`employee_data.sensitive.history:read`

List Bulk Right To Work History`hibob_list_bulk_right_to_work_history`

Get right-to-work history for multiple employees

`employee_data.history:read`

Search Actual Payments`hibob_search_actual_payments`

Search for actual payments based on filters

`employee_data.sensitive.history:write`

Get Payroll History`hibob_get_payroll_history`

Read payroll tables history (legacy endpoint)

`employee_data.sensitive:read`

Search Employees`hibob_search_employees`

Search for employees by ID/email or retrieve all employees. Fields must use full dot-path format (e.g. root.id, root.fir...

`employee_data:read`

Get Employee`hibob_get_employee`

Retrieve detailed employee data by employee ID

`employee_data:read`

Create Employee`hibob_create_employee`

Create a new employee record in HiBob

`employee_data:write`

Update Employee`hibob_update_employee`

Update existing employee information

`employee_data:write`

Terminate Employee`hibob_terminate_employee`

Terminate an employee and set their end date

`employee_data:write`

Revoke Employee Access`hibob_uninvite_employee`

Revoke access to Bob for an employee

`employee_data:write`

Invite Employee`hibob_invite_employee`

Send an invitation to an employee with a welcome wizard

`employee_data:write`

Update Employee Start Date`hibob_update_employee_start_date`

Set or update an employee's start date

`employee_data:write`

Get Avatar By Email`hibob_get_avatar_by_email`

Read avatar for an employee by email

`employee_data:read`

Get Avatar By Employee ID`hibob_get_employee_avatar`

Read avatar for an employee by ID

`employee_data:read`

Upload Employee Avatar`hibob_upload_employee_avatar`

Upload employee's avatar by public image URL

`employee_data:write`

Update Employee Email`hibob_update_employee_email`

Update an employee's email address

`employee_data:write`

Get Goal Type Metadata`hibob_get_goal_type_metadata`

Get goal type metadata fields

`goals:write`

Get Goals Metadata`hibob_get_goals_metadata`

Get goals metadata fields

`goals:write`

Get Key Results Metadata`hibob_get_key_results_metadata`

Get key results metadata fields

`goals:write`

Search Goal Types`hibob_search_goal_types`

Search for available goal types

`goals:write`

Search Goals`hibob_search_goals`

Search for goals

`goals:write`

Search Key Results`hibob_search_key_results`

Search for key results of a specific goal

`goals:write`

Create Goals`hibob_create_goals`

Create multiple goals

`goals:write`

Update Goal Status`hibob_update_goal_status`

Update the status of an existing goal

`goals:write`

Update Goal`hibob_update_goal`

Update an existing goal details

`goals:write`

Delete Goal`hibob_delete_goal`

Delete an existing goal

`goals:write`

Create Key Results`hibob_create_key_results`

Create key results for a specific goal

`goals:write`

Update Key Results Progress`hibob_update_key_results_progress`

Update the progress of key results for a goal

`goals:write`

Update Key Results Details`hibob_update_key_results_details`

Update the details of key results

`goals:write`

Delete Key Result`hibob_delete_key_result`

Delete a specific key result from a goal

`goals:write`

Search Job Ads`hibob_search_job_ads`

Get all active job ads from your career page

`hiring:write`

Get Job Ad`hibob_get_job_ad`

Get the details of a single job ad

`hiring:write`

Search Job Profiles`hibob_search_job_profiles`

Search for company job profiles

`job_catalog:read`

Get Job Roles`hibob_get_job_roles`

Get all job roles

`job_catalog:read`

Get Job Families`hibob_get_job_families`

Get all job families

`job_catalog:read`

Get Job Family Groups`hibob_get_job_family_groups`

Get all job family groups

`job_catalog:read`

Get Job Profiles Metadata`hibob_get_job_profiles_metadata`

Get job profiles metadata

`job_catalog:read`

Get Job Roles Metadata`hibob_get_job_roles_metadata`

Get job roles metadata

`job_catalog:read`

Get Job Families Metadata`hibob_get_job_families_metadata`

Get job families metadata

`job_catalog:read`

Get Job Family Groups Metadata`hibob_get_job_family_groups_metadata`

Get job family groups metadata

`job_catalog:read`

Get All Employee Fields`hibob_get_all_fields`

Get all employee field definitions

`company.metadata:read`

Create Custom Field`hibob_create_custom_field`

Create a new custom employee field

`company.metadata:write`

Update Custom Field`hibob_update_custom_field`

Update an existing custom field

`company.metadata:write`

Delete Custom Field`hibob_delete_custom_field`

Delete a custom field

`company.metadata:write`

Get All Company Lists`hibob_get_all_company_lists`

Get all company-defined lists

`company.metadata:read`

Get Company List By Name`hibob_get_company_list_by_name`

Get a specific company list by name

`company.metadata:read`

Add Item To List`hibob_add_item_to_list`

Add a new item to a company list

`company.metadata:write`

Update List Item`hibob_update_list_item`

Update an existing item in a company list

`company.metadata:write`

Delete List Item`hibob_delete_list_item`

Delete an item from a company list

`company.metadata:write`

Get Onboarding Wizards`hibob_get_onboarding_wizards`

Get a summary of all onboarding wizards

`company.metadata:read`

Get Company Reports`hibob_get_company_reports`

Get list of available reports

`reports:read`

Get Report Download URL For Polling`hibob_get_report_download_url`

Get async download URL for a report

`reports:read`

List All Open Tasks`hibob_list_all_open_tasks`

Get all open tasks across all employees

`tasks:write`

List Employee Tasks`hibob_list_employee_tasks`

Get tasks for a specific employee

`tasks:write`

Mark Task As Complete`hibob_mark_task_complete`

Mark a task as complete

`tasks:write`

Create Time Off Request`hibob_create_time_off_request`

Submit a new time off request for an employee

`timeoff:write`

Get Time Off Request`hibob_get_time_off_request`

Retrieve details of a specific time off request

`timeoff:read`

Cancel Time Off Request`hibob_cancel_time_off_request`

Cancel an existing time off request

`timeoff:write`

Get Time Off Changes`hibob_get_time_off_changes`

Get all time off requests that changed since a specific date

`timeoff:read`

Get Who's Out`hibob_get_whos_out`

Get list of employees who are out of office

`timeoff:read`

Get Who's Out Today`hibob_get_whos_out_today`

Get employees who are out of office today or on a specific date

`timeoff:read`

Get Employee Time Off Balance`hibob_get_employee_time_off_balance`

Get time off balance for an employee

`timeoff:read`

Adjust Time Off Balance`hibob_adjust_time_off_balance`

Create a balance adjustment for an employee

`timeoff:write`

Get Policy Type Reason Codes`hibob_get_policy_type_reason_codes`

Get reason codes for a policy type

`timeoff:read`

Add Policy Type Reason Codes`hibob_add_policy_type_reason_codes`

Add reason codes to a policy type

`timeoff:write`

Get Policy Type Details`hibob_get_policy_type_details`

Get details about a policy type

`timeoff:read`

Get All Policy Types`hibob_get_all_policy_types`

Get all policy type names

`timeoff:read`

Get Policy Details`hibob_get_policy_details`

Get details about a policy by policy name

`timeoff:read`

Get Policy Names`hibob_get_policy_names`

Get policy names for a policy type

`timeoff:read`

Import Attendance Data`hibob_import_attendance_data`

Import attendance punches for employees

`attendance:write`

Get Positions Metadata`hibob_get_positions_metadata`

Get all positions fields metadata

`workforce_planning:read`

Get Position Openings Metadata`hibob_get_position_openings_metadata`

Get all position openings fields metadata

`workforce_planning:write`

Get Position Budget Metadata`hibob_get_position_budget_metadata`

Get all position budget fields metadata

`workforce_planning:write`

Search Positions`hibob_search_positions`

Search for company positions

`workforce_planning:write`

Search Position Openings`hibob_search_position_openings`

Search for company position openings

`workforce_planning:write`

Search Position Budgets`hibob_search_position_budgets`

Search for company position budgets

`workforce_planning:write`

Create Position`hibob_create_position`

Create a new position

`workforce_planning:write`

Create Position Opening`hibob_create_position_opening`

Create a position opening for a specific position

`workforce_planning:write`

Update Position`hibob_update_position`

Update an existing position

`workforce_planning:write`

Update Position Opening`hibob_update_position_opening`

Update an existing position opening

`workforce_planning:write`

Delete Position Opening`hibob_delete_position_opening`

Delete a position opening

`workforce_planning:write`

Create Position Budget`hibob_create_position_budget`

Create a position budget for a specific position

`workforce_planning:write`

Update Position Budget`hibob_update_position_budget`

Update an existing position budget

`workforce_planning:write`

Cancel Position`hibob_cancel_position`

Cancel a position

`workforce_planning:write`

## Events

Tags

Select all
|
Clear

Documents

Employee Tables

Employees

Tasks

Time Off

Webhooks

Workforce Planning

No tags found

28 events

EventDescriptionTags

Employee Created`hibob_webhook_employee_created`

Processes HiBob employee.created events fired when a new employee is added.

EmployeesWebhooks

Employee Updated`hibob_webhook_employee_updated`

Processes HiBob employee.updated events fired when an employee field is modified.

EmployeesWebhooks

Employee Deleted`hibob_webhook_employee_deleted`

Processes HiBob employee.deleted events fired when an employee record is removed.

EmployeesWebhooks

Employee Inactivated`hibob_webhook_employee_inactivated`

Processes HiBob employee.inactivated events fired when an employee is set on leave or terminated.

EmployeesWebhooks

Employee Activated`hibob_webhook_employee_activated`

Processes HiBob employee.activated events fired when an employee's system access is enabled.

EmployeesWebhooks

Employee Joined`hibob_webhook_employee_joined`

Processes HiBob employee.joined events fired when an employee is granted access to the system.

EmployeesWebhooks

Employee Left`hibob_webhook_employee_left`

Processes HiBob employee.left events fired when an employee is terminated or placed on garden leave.

EmployeesWebhooks

Employee Temporary Leave`hibob_webhook_employee_temporary_leave`

Processes HiBob employee.temporaryLeave events fired when an employee is placed on temporary leave.

EmployeesWebhooks

Table Entry Created`hibob_webhook_table_entry_created`

Processes HiBob table.entry.created events fired when an entry is added to an employee table.

Employee TablesWebhooks

Table Entry Updated`hibob_webhook_table_entry_updated`

Processes HiBob table.entry.updated events fired when an entry in an employee table is modified.

Employee TablesWebhooks

Time Off Request Submitted`hibob_webhook_timeoff_request_requested`

Processes HiBob timeoff.request.requested events fired when a time off request is submitted.

Time OffWebhooks

Time Off Request Updated`hibob_webhook_timeoff_request_updated`

Processes HiBob timeoff.request.updated events fired when a time off request is modified.

Time OffWebhooks

Time Off Request Approved`hibob_webhook_timeoff_request_approved`

Processes HiBob timeoff.request.approved events fired when a time off request is approved.

Time OffWebhooks

Time Off Request Declined`hibob_webhook_timeoff_request_declined`

Processes HiBob timeoff.request.declined events fired when a time off request is rejected.

Time OffWebhooks

Time Off Request Cancelled`hibob_webhook_timeoff_request_cancelled`

Processes HiBob timeoff.request.cancelled events fired when a time off request is cancelled.

Time OffWebhooks

Time Off Request Deleted`hibob_webhook_timeoff_request_deleted`

Processes HiBob timeoff.request.deleted events fired when a time off request is permanently removed.

Time OffWebhooks

Time Off Request Imported`hibob_webhook_timeoff_request_imported`

Processes HiBob timeoff.request.imported events fired when a time off request is created via import.

Time OffWebhooks

Time Off Request End Date Set`hibob_webhook_timeoff_request_set_end_date`

Processes HiBob timeoff.request.setEndDate events fired when the end date is set on an open-ended time off request.

Time OffWebhooks

Task List Triggered`hibob_webhook_todo_assign`

Processes HiBob todo.assign events fired when a task list is triggered for an employee.

TasksWebhooks

Task Status Changed`hibob_webhook_todo_changed_status`

Processes HiBob todo.changedStatus events fired when a task is marked complete or incomplete.

TasksWebhooks

eSign Document Completed`hibob_webhook_documents_esign_completed`

Processes HiBob documents.eSign.completed events fired when all parties have signed an eSign document.

DocumentsWebhooks

Position Created`hibob_webhook_position_created`

Processes HiBob workforcePlanning.position.created events fired when a new position is created.

Workforce PlanningWebhooks

Position Updated`hibob_webhook_position_updated`

Processes HiBob workforcePlanning.position.updated events fired when a position is modified.

Workforce PlanningWebhooks

Position Opening Created`hibob_webhook_position_opening_created`

Processes HiBob workforcePlanning.positionOpening.created events fired when a new position opening is created.

Workforce PlanningWebhooks

Position Opening Updated`hibob_webhook_position_opening_updated`

Processes HiBob workforcePlanning.positionOpening.updated events fired when a position opening is modified.

Workforce PlanningWebhooks

Position Opening Deleted`hibob_webhook_position_opening_deleted`

Processes HiBob workforcePlanning.positionOpening.deleted events fired when a position opening is removed.

Workforce PlanningWebhooks

Position Budget Created`hibob_webhook_position_budget_created`

Processes HiBob workforcePlanning.positionBudget.created events fired when a new position budget is created.

Workforce PlanningWebhooks

Position Budget Updated`hibob_webhook_position_budget_updated`

Processes HiBob workforcePlanning.positionBudget.updated events fired when a position budget is modified.

Workforce PlanningWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.