Skip to main content
hibob icon

HiBob Connector

SourceAPI DocsAPI ChangelogConnector Changelog

Description​

HiBob is an HR platform for people management, performance, and engagement. This component allows managing employee data using the HiBob API, including employee profiles, work history, salary information, and bank account details.

API Documentation​

This component was built using the HiBob API Reference

Connections​

Basic Authentication​

key: hibob-connection

Create a connection of type Basic Authentication to authenticate with the HiBob API using a Service User ID and token.

Prerequisites​

  • A HiBob account with administrator access
  • Access to the Service Users configuration page in HiBob

Setup Steps​

  1. Log in to the HiBob admin panel and navigate to the Service Users configuration page
  2. Click Create a New Service User
  3. Copy the Service User ID and Token immediately, as the token can only be viewed once
  4. Create a dedicated permission group for the service user:
    • Add the service user to the group
    • Configure the necessary permissions based on the API operations to perform
    • For basic employee data access, ensure the Default Employee Fields permissions are enabled
Administrator Access Required

If direct access to the HiBob admin panel is not available, contact a HiBob administrator to generate the credentials.

Configure the Connection​

  • Enter the Service User ID from the HiBob admin panel
  • Enter the Token generated during service user creation
  • Set Use Sandbox to true to connect to the HiBob sandbox environment instead of production

Refer to the HiBob API Service Users documentation for additional details on permissions and access configuration.

InputNotesExample
Service User ID

The HiBob API Service User ID.

api-user@company.com
Token

The HiBob API token.

abc123...
Use Sandbox

When true, connects to the HiBob sandbox environment instead of production.

false

OAuth 2.0​

key: hibob-oauth2

Create a connection of type OAuth 2.0 to authenticate with HiBob using the OAuth 2.0 Authorization Code flow.

Prerequisites​

  • A HiBob account with access to the Developer Portal
  • An OAuth application registered in the HiBob Developer Portal

Setup Steps​

  1. Navigate to the HiBob Developer Portal and create or select an OAuth application
  2. In the application's OAuth section, locate the App Installation URL (this is the Authorize URL)
  3. Copy the Client ID and Client Secret from the application settings
  4. Configure the required scopes under Manage Scopes in the Developer Portal
  5. Set the OAuth callback URL to https://oauth2.prismatic.io/callback in the application's redirect URI settings

Configure the Connection​

  • Enter the Authorize URL (the App Installation URL from the Developer Portal)
  • Enter the Client ID and Client Secret from the application settings
  • For Scopes, enter the required scopes separated by spaces. Configure scopes in the HiBob Developer Portal under Manage Scopes

Refer to the HiBob API documentation for additional details on available scopes and permissions.

InputNotesExample
Authorize URL

The App Installation URL from the HiBob Developer Portal. Navigate to the app's OAuth section to find this URL.

https://app.hibob.com/app-marketplace/install/...
Client ID

The Client ID from the HiBob Developer Portal.

Client Secret

The Client Secret from the HiBob Developer Portal.

Scopes

Space-separated OAuth 2.0 scopes. Configure in the HiBob Developer Portal under Manage Scopes.

read.people read.time-off write.people
Token URL

The OAuth 2.0 Token URL for HiBob.

https://auth.app.hibob.com/oauth2/v1/apps/token
Use Sandbox

When true, connects to the HiBob sandbox environment instead of production.

false

Triggers​

Webhook​

Receive and validate webhook requests from HiBob for manually configured webhook subscriptions. | key: webhook

InputNotesExample
App Secret

The secret key used to validate webhook signatures from HiBob.

wh_secret_abc123def456

HiBob can be configured to send webhook notifications to a flow's webhook URL when events occur in the system, such as employee creation, time-off requests, task assignments, and more.

This trigger validates incoming webhook requests using HMAC SHA-512 signature verification to ensure that payloads are authentic.

How It Works​

This trigger handles two types of incoming requests via separate branches:

  • Ping Test: When a webhook is first registered in HiBob, a ping test request is sent to verify the endpoint is reachable. The trigger automatically detects this request and responds with a 200 OK status.
  • Event Notification: All subsequent webhook requests contain event data. The trigger verifies the HMAC SHA-512 signature in the Bob-Signature header against the configured App Secret. If the signature is valid, the payload is passed to this branch for processing. If the signature is invalid, an error is thrown and the flow does not execute.

Configuration​

Configure the following input:

  • App Secret: The secret key used to validate webhook signatures from HiBob. This value is generated when creating a webhook subscription in the HiBob UI.

Event Types​

Available Events (28)
EventDescription
employee.createdA new employee is added
employee.updatedEmployee information is modified
employee.deletedAn employee record is removed
employee.joinedAn employee officially starts work
employee.terminatedEmployment ends
employee.activatedAn employee account becomes active
employee.inactivatedAn employee account is deactivated
employee.temporary.leaveTemporary leave status changes
table.entry.createdA new row is added to an employee table
table.entry.updatedAn employee table row is modified
timeoff.request.requestedA time-off request is submitted
timeoff.request.approvedA time-off request is approved
timeoff.request.declinedA time-off request is denied
timeoff.request.cancelledA time-off request is withdrawn
timeoff.request.deletedA time-off request is removed
timeoff.request.updatedTime-off request details change
timeoff.request.importedA time-off request is imported from an external source
timeoff.request.set.end.dateAn end date is set on a time-off request
todo.assignA task is assigned to an employee
todo.changed.statusTask completion status changes
documents.esign.completedDocument signing is finalized
workforce.planning.position.createdA new position is created
workforce.planning.position.updatedA position is modified
workforce.planning.position.opening.createdA new position opening is created
workforce.planning.position.opening.updatedA position opening is modified
workforce.planning.position.opening.deletedA position opening is removed
workforce.planning.position.budget.createdA new budget entry is created
workforce.planning.position.budget.updatedA budget entry is modified

Refer to the HiBob Webhooks documentation for the complete and up-to-date list of available events.

Returned Data​

Example Payload (Webhooks v2)
{
  "companyId": 12345,
  "type": "employee.updated",
  "appId": "app-id",
  "employeeId": "3142451612119",
  "data": {
    "changedFields": ["root/work/title", "root/work/department"],
    "employee": {
      "id": "3142451612119",
      "displayName": "Jane Smith"
    }
  }
}

Notes​

  • HiBob webhooks v2 payloads contain metadata about changed fields rather than full record data. Use the HiBob API to retrieve complete record details when needed.
  • The trigger rejects requests with missing or invalid signatures, preventing unauthorized payloads from executing the flow.

Data Sources​

Select Company List​

Select a company list. | key: selectCompanyList | type: picklist

InputNotesExample
Connection

The HiBob connection to use.

Select Employee​

Select an employee. | key: selectEmployee | type: picklist

InputNotesExample
Connection

The HiBob connection to use.

Select Employee Field​

Select an employee field. | key: selectEmployeeField | type: picklist

InputNotesExample
Connection

The HiBob connection to use.

Select Folder​

Select a document folder. | key: selectFolder | type: picklist

InputNotesExample
Connection

The HiBob connection to use.

Select Task​

Select a task. | key: selectTask | type: picklist

InputNotesExample
Connection

The HiBob connection to use.

Actions​

Add List Item​

Adds a new item to an existing company list. | key: addListItem

InputNotesExample
Connection

The HiBob connection to use.

Item Name

The name of the new list item.

Human Resources
List Name

The name of the list to add the item to.

Departments
Parent ID

ID of the new hierarchy parent node.

1234567890
Example Payload for Add List Item⤓
Loading…

Complete Task​

Marks a task as completed. | key: completeTask

InputNotesExample
Connection

The HiBob connection to use.

Task ID

The ID of the task to complete.

21345678
Example Payload for Complete Task⤓
Loading…

Create Custom Table Entry​

Creates a new entry in a custom table for an employee. | key: createCustomTableEntry

InputNotesExample
Connection

The HiBob connection to use.

Custom Table ID

The unique identifier for the custom table.

custom_table_123
Employee ID

The ID of the employee to create the custom table entry for.

employee_123
Entry Data

The data for the custom table entry in JSON format.

[
  {
    "Certification Name": "AWS Solutions Architect",
    "Issuing Organization": "Amazon Web Services",
    "Issue Date": "2023-01-15",
    "Expiration Date": "2026-01-15"
  }
]
Example Payload for Create Custom Table Entry⤓
Loading…

Create Employee​

Creates a new employee with the specified fields. | key: createEmployee

InputNotesExample
Connection

The HiBob connection to use.

Email

The work email address assigned to the employee.

john.doe@example.com
First Name

The given name of the employee.

John
Site

The office location or branch assigned to the employee.

London
Start Date

The date when the employee begins employment. Format: YYYY-MM-DD.

2024-01-01
Surname

The last name or family name of the employee.

Doe
Example Payload for Create Employee⤓
Loading…

Create New Field​

Creates a new custom field in HiBob. | key: createNewField

InputNotesExample
Category

The grouping category under which the field is organized.

Custom Field
Connection

The HiBob connection to use.

Description

A description of the field's purpose.

This field stores custom employee data
Historical

When true, this field keeps the history of its values, each being active starting from a certain date.

false
Field Name

The name of the new field to create.

Custom Field
Field Type

The data type of the new field.

Example Payload for Create New Field⤓
Loading…

Delete Custom Table Entry​

Deletes an existing entry from a custom table for an employee. | key: deleteCustomTableEntry

InputNotesExample
Connection

The HiBob connection to use.

Custom Table ID

The ID of the custom table containing the entry to delete.

custom_table_123
Employee ID

The ID of the employee whose custom table entry will be deleted.

employee_123
Entry ID

The ID of the custom table entry to delete.

entry_123
Example Payload for Delete Custom Table Entry⤓
Loading…

Delete Field​

Deletes an existing custom field from HiBob. | key: deleteField

InputNotesExample
Connection

The HiBob connection to use.

Field ID

The ID of the field to delete.

custom_field_123
Example Payload for Delete Field⤓
Loading…

Delete File From Folder​

Deletes a file from an employee's document folder. | key: deleteFileFromFolder

InputNotesExample
Connection

The HiBob connection to use.

Document ID

The ID of the document to delete.

23278123
Employee ID

The ID of the employee whose file to delete.

employee_123
Folder ID

Required if folder type is 'Custom'. The ID of the custom folder containing the file.

1044123
Folder Type

The type of folder containing the file to delete.

Example Payload for Delete File From Folder⤓
Loading…

Delete List Item​

Deletes an existing item from a company list. | key: deleteListItem

InputNotesExample
Connection

The HiBob connection to use.

Item ID

The ID of the list item to delete.

1044123
List Name

The name of the list containing the item to delete.

Departments
Example Payload for Delete List Item⤓
Loading…

Download Employee Documents​

Downloads a list of documents for an employee. | key: downloadEmployeeDocuments

InputNotesExample
Connection

The HiBob connection to use.

Employee ID

The ID of the employee whose documents to download.

employee_123
Example Payload for Download Employee Documents⤓
Loading…

Get Company List​

Retrieves a specific named list from the company. | key: getCompanyList

InputNotesExample
Connection

The HiBob connection to use.

Include Archived

When true, includes archived items in the response.

false
List Name

The name of the list to retrieve.

Departments
Example Payload for Get Company List⤓
Loading…

Get Custom Table Metadata​

Retrieves metadata for a specific custom table. | key: getCustomTableMetadata

InputNotesExample
Connection

The HiBob connection to use.

Custom Table ID

The ID of the custom table to retrieve metadata for.

custom_table_123
Example Payload for Get Custom Table Metadata⤓
Loading…

Get Employee Tasks​

Retrieves all tasks assigned to a specific employee. | key: getEmployeeTasks

InputNotesExample
Connection

The HiBob connection to use.

Employee ID

The Employee ID as pulled from the database, or from the URL In Bob when viewing the employee.

3332883884017713238
Task Status

Filter tasks by open / closed status. Not sending any value will return all tasks.

Example Payload for Get Employee Tasks⤓
Loading…

List Company Lists​

Retrieves all named lists in the company. | key: listCompanyLists

InputNotesExample
Connection

The HiBob connection to use.

Include Archived

When true, includes archived items in the response.

false
Example Payload for List Company Lists⤓
Loading…

List Employee Fields​

Retrieves a list of all employee fields in the company. | key: listEmployeeFields

InputNotesExample
Connection

The HiBob connection to use.

Example Payload for List Employee Fields⤓
Loading…

List Folders​

Retrieves a list of all document folders in the system. | key: listFolders

InputNotesExample
Connection

The HiBob connection to use.

Example Payload for List Folders⤓
Loading…

List Open Tasks​

Retrieves a list of all open tasks in the system. | key: listOpenTasks

InputNotesExample
Connection

The HiBob connection to use.

Example Payload for List Open Tasks⤓
Loading…

Raw Request​

Sends a raw HTTP request to the HiBob API. | key: rawRequest

InputNotesExample
Connection

The HiBob connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/docs/folders/metadata). The base URL is determined by the connection's sandbox setting (https://api.hibob.com/v1 for production, https://api.sandbox.hibob.com/v1 for sandbox). For example, to connect to https://api.hibob.com/v1/docs/folders/metadata, only /docs/folders/metadata is entered in this field.

/docs/folders/metadata
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Read Employee Fields​

Retrieves employee data for a specific employee by ID or email. | key: readEmployeeFields

InputNotesExample
Connection

The HiBob connection to use.

Fields

An optional list of fields to be returned in the response. When not specified, a default set of fields and categories are returned.

[
  "root.name",
  "root.email"
]
Human Readable

A flag that determines the data format to be returned in the response payload. Use this flag to convert "machine format" numeric IDs, such as "1644513820829" to the "human readable" values.

Employee Identifier

The employee's ID or email address to retrieve data for.

3332883884017713238
Example Payload for Read Employee Fields⤓
Loading…

Revoke Employee Access​

Revokes access to HiBob for a specific employee. | key: revokeEmployeeAccess

InputNotesExample
Connection

The HiBob connection to use.

Employee Identifier

The employee's ID or email address to revoke access for.

3332883884017713238
Example Payload for Revoke Employee Access⤓
Loading…

Search Employee​

Searches for employees based on specified criteria. | key: searchEmployee

InputNotesExample
Connection

The HiBob connection to use.

Fields

An optional list of fields to be returned in the response. When not specified, a default set of fields and categories are returned.

[
  "root.fullName",
  "root.id"
]
Filters

An optional filter based on a field and a condition to filter the results.

[
  {
    "fieldPath": "root.id",
    "operator": "equals",
    "values": [
      "<employee ID>"
    ]
  }
]
Human Readable

A flag that determines the data format to be returned in the response payload. Use this flag to convert "machine format" numeric IDs, such as "1644513820829" to the "human readable" values.

Show Inactive

When true, includes inactive employees in the response.

false
Example Payload for Search Employee⤓
Loading…

Terminate Employee​

Terminates a specific employee with a given termination date and reason. | key: terminateEmployee

InputNotesExample
Connection

The HiBob connection to use.

Employee Identifier

The backend-id of the Employee to terminate. Retrieve this ID from the database.

3332883884017713238
Last Day of Work

The final working date before the employee's departure. Format: YYYY-MM-DD.

2025-09-22
Notice Period

The duration of the notice period before the employee's departure. Provide as a JSON object with 'length' and 'unit' properties.

{
  "length": 30,
  "unit": "days"
}
Reason

The ID of the 'lifecycleReasonType' list entry.

End of Contract
Termination Date

The date when the employee's termination takes effect (YYYY-MM-DD format).

2024-03-15
Termination Reason

The ID of the 'terminationReason' list entry.

Redundant
Example Payload for Terminate Employee⤓
Loading…

Update Custom Table Entry​

Updates an existing entry in a custom table for an employee. | key: updateCustomTableEntry

InputNotesExample
Connection

The HiBob connection to use.

Custom Table ID

The ID of the custom table containing the entry to update.

custom_table_123
Employee ID

The ID of the employee whose custom table entry will be updated.

employee_123
Entry Data

The updated data for the custom table entry in JSON format.

{
  "Certification Name": "AWS Solutions Architect Professional",
  "Issuing Organization": "Amazon Web Services",
  "Issue Date": "2023-01-15",
  "Expiration Date": "2026-01-15"
}
Entry ID

The ID of the custom table entry to update.

entry_123
Example Payload for Update Custom Table Entry⤓
Loading…

Update Employee​

Updates employee data for a specific employee by ID or email. | key: updateEmployee

InputNotesExample
Connection

The HiBob connection to use.

Fields

The fields to update for the employee. This should be a JSON object containing the field paths and their new values.

{
  "home": {
    "mobilePhone": "63635356"
  },
  "firstName": "Jacky"
}
Employee Identifier

The employee's ID to update.

3332883884017713238
Example Payload for Update Employee⤓
Loading…

Update Employee Email​

Updates the email address for a specific employee. | key: updateEmployeeEmail

InputNotesExample
Connection

The HiBob connection to use.

New Email Address

The new email address for the employee.

john.doe@example.com
Employee Identifier

The employee's ID to update the email address for.

3332883884017713238
Example Payload for Update Employee Email⤓
Loading…

Update Field​

Updates an existing custom field in HiBob. | key: updateField

InputNotesExample
Connection

The HiBob connection to use.

Description

A new description for the field.

Updated field description
Field ID

The ID of the field to update.

custom_field_123
Field Name

The new name for the field.

Updated Field Name
Example Payload for Update Field⤓
Loading…

Update List Item​

Updates an existing item in a company list. | key: updateListItem

InputNotesExample
Connection

The HiBob connection to use.

Item ID

The ID of the list item to update.

1044123
Item Name

The new name for the list item.

Human Resources Department
List Name

The name of the list containing the item to update.

Departments
Parent ID

The ID of the new hierarchy parent node.

1234
Example Payload for Update List Item⤓
Loading…

Upload File From URL​

Uploads a file from a URL to an employee's document folder. | key: uploadFileFromUrl

InputNotesExample
Connection

The HiBob connection to use.

Document Name

The display name for the uploaded document, including file extension.

document.pdf
Document URL

The URL pointing to the document to upload.

https://example.com/documents/file.pdf
Employee ID

The ID of the employee to upload the file for.

23278123
Folder ID

Required if folder type is 'Custom'. The ID of the custom folder to upload to.

1044123
Folder Type

The type of folder to upload the file to.

Tags

An array of tags to attach to the document in Bob.

["tag1","tag2"]
Example Payload for Upload File From URL⤓
Loading…

Upload File To Folder​

Uploads a file directly to an employee's document folder. | key: uploadFileToFolder

InputNotesExample
Connection

The HiBob connection to use.

Employee ID

The ID of the employee to upload the file for.

23278123
File Data

The binary data of the file to upload. This should be a reference to a previous action that returns file data.

File Name

The desired file name for the uploaded document, including extension.

document.pdf
Folder ID

Required if folder type is 'Custom'. The ID of the custom folder to upload to.

1044123
Folder Type

The type of folder to upload the file to.

Example Payload for Upload File To Folder⤓
Loading…

Changelog​

2026-04-30​

Updated spectral version

2026-04-07​

Various modernizations and documentation updates

2026-04-06​

Added OAuth 2.0 Authorization Code connection as an additional authentication method alongside the existing Basic Authentication connection

2025-05-08​

Initial release of HiBob component with comprehensive employee management, custom table operations, file management, and task management capabilities