FlowmageDocs

Request time off

BetaChanges data

Submits a HiBob time off request in the shape the policy wants.

Settings

SettingWhat it is
ConnectionRequiredThe HiBob connection the step signs in with.
Employee idRequiredPicked from the list HiBob offers.
Policy typeRequiredAs the List time off policy types node spells it.
How the time is countedBob's policies are counted in days or in hours, and the request has to be written the way the policy counts. The List time off policy types node says which.
FromRequiredYYYY-MM-DD.
ToRequiredYYYY-MM-DD. The same day as From for a single day.
First day"all_day" or "afternoon"
Last day"all_day" or "morning"
Hoursnumber
Minutesnumber
Hours per daynumber
Minutes per daynumber
Which half of the day"morning" or "afternoon"
From timeHH:mm in the employee's own time zone.
To timetext
Per-day durationsOne entry per day between From and To, in Bob's own shape: a portion for each day, or a start and end time for each day.
NoteWhat the person wrote on the request. Everyone who may see the request reads it.
ReasonThe numeric id of a reason Bob offers for this policy — the List time off policy types node leads to them. 0 means no reason.
ApproverThe employee id of the person who should approve it, instead of the default.
Approve it straight awayAdmins only. Switching this on creates the request already approved and skips the person's manager entirely.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `hibob`)
employeeIdtexta value from the vendor's own list
policyTypetext
requestRangeType"days" or "hours" or "portionOnRange" or "hoursOnRange" or "specificHoursOnRange" or "differentDayDurations" or "differentSpecificHoursDayDurations", by default "days"
startDatetext
endDatetext
startDatePortion"all_day" or "afternoon", by default "all_day"used when `requestRangeType` is "days"
endDatePortion"all_day" or "morning", by default "all_day"used when `requestRangeType` is "days"
hoursnumber, by default 0used when `requestRangeType` is "hours"
minutesnumber, by default 0used when `requestRangeType` is "hours"
dailyHoursnumber, by default 0used when `requestRangeType` is "hoursOnRange"
dailyMinutesnumber, by default 0used when `requestRangeType` is "hoursOnRange"
dayPortion"morning" or "afternoon", by default "morning"used when `requestRangeType` is "portionOnRange"
localStartTimetextused when `requestRangeType` is "specificHoursOnRange"
localEndTimetextused when `requestRangeType` is "specificHoursOnRange"
durationslist of any JSON, by default []used when `requestRangeType` is one of "differentDayDurations", "differentSpecificHoursDayDurations"
descriptiontext
reasonCodenumber, by default 0
approvertext
skipManagerApprovaltrue/false, by default false

Output

FieldType
requestIdstring
requestobject
Sample output, and the expression for each field
  • request
    • id"912"
  • requestId"912"

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": {
    "approver": "",
    "connection": "<connection id>",
    "dailyHours": 0,
    "dailyMinutes": 0,
    "dayPortion": "morning",
    "description": "",
    "durations": [],
    "employeeId": "<employee id>",
    "endDate": "<to>",
    "endDatePortion": "all_day",
    "hours": 0,
    "localEndTime": "",
    "localStartTime": "",
    "minutes": 0,
    "policyType": "<policy type>",
    "reasonCode": 0,
    "requestRangeType": "days",
    "skipManagerApproval": false,
    "startDate": "<from>",
    "startDatePortion": "all_day"
  },
  "label": "Request time off",
  "type": "hibob.createTimeOffRequest",
  "version": 1
}