HiBobSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The HiBob connection the step signs in with. |
| Fields to fetch | Bob's hiring search has no default set — at least one id, at most 50. The useful ones are /candidate/id, /candidate/firstName, /candidate/lastName, /candidate/email, /candidate/phone, /candidate/city, /candidate/country, /candidate/employeeId, /candidate/jobOpeningsToApplicationIds, /candidate/sourceType and /candidate/modificationDate. /candidate/employeeId is the link to the employee record once the candidate is hired — ask for it if the flow carries on into Bob itself. |
| Filters | Bob filters on /candidate/id, /candidate/email, /candidate/firstName, /candidate/lastName and /candidate/modificationDate, with equals, notEqual, greaterThan or lessThan. Anything else is refused by Bob — filter the rest downstream. |
| Include archived candidates | true/false |
| Fetch every page | Follows Bob's cursor, and refuses past 20,000 candidates rather than answering a short list. |
| Candidates per call | 1 to 200. Bob's own default is 100. |
| Start at cursor | The Next cursor from an earlier run, to carry on where it stopped. Leave empty to start at the beginning. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `hibob`) |
fields | text, by default "/candidate/id,/candidate/firstName,/candidate/lastName,/candidate/email" |
filters | list of any JSON, by default [] |
includeArchived | true/false, by default false |
returnAll | true/false, by default false |
limit | number, by default 100 |
cursor | text |
Output
| Field | Type |
|---|---|
candidates | array |
candidateCountCandidates in this answer | number |
hasMoreMore candidates are waiting behind this page | boolean |
nextCursor | string |
Sample output, and the expression for each field
- candidateCount0
- candidates[]
- hasMorefalse
- nextCursor""
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"cursor": "",
"fields": "/candidate/id,/candidate/firstName,/candidate/lastName,/candidate/email",
"filters": [],
"includeArchived": false,
"limit": 100,
"returnAll": false
},
"label": "Search candidates",
"type": "hibob.searchCandidates",
"version": 1
}