HiBobSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The HiBob connection the step signs in with. |
| Fields to fetch | At least one id, at most 50 — it starts with the six Bob's reference suggests. Application field ids are written like /application/id and are listed on Bob's own hiring API reference; the Search candidates node's /candidate/jobOpeningsToApplicationIds gives you the ids to filter on. |
| Filters | Each filter is a field id, an operator (equals, notEqual, greaterThan or lessThan) and the values to match. Bob refuses a field it does not filter on — filter the rest downstream. |
| Include archived applications | true/false |
| Fetch every page | Follows Bob's cursor, and refuses past 20,000 applications rather than answering a short list. |
| Applications per call | 1 to 200. Bob's own default is 100. |
| Start at cursor | The Next cursor from an earlier run. Leave empty to start at the beginning. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `hibob`) |
fields | text, by default "/application/id,/application/candidateId,/application/jobOpeningId,/application/status,/application/stageId,/application/createdAt" |
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 |
|---|---|
applications | array |
applicationCountApplications in this answer | number |
hasMoreMore applications are waiting behind this page | boolean |
nextCursor | string |
Sample output, and the expression for each field
- applicationCount0
- applications[]
- 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": "/application/id,/application/candidateId,/application/jobOpeningId,/application/status,/application/stageId,/application/createdAt",
"filters": [],
"includeArchived": false,
"limit": 100,
"returnAll": false
},
"label": "Search applications",
"type": "hibob.searchApplications",
"version": 1
}