Skip to main content

add_time_off_request

Facts​

DescriptionAdd a time off request
SchemaConnectors.Deel.functions.AddTimeOffRequest
ServiceDeel

Input parameters​

Required input parameters

contract_idstringRequired

The ID of the contract related to the employee requesting time off

Examples
12345
deel_access_tokenslack#/types/credential/oauth2Required

Deel Access token. See the authentication section for details.

end_dateslack#/types/dateRequired

The date the requested time-off period will end, in YYYY-MM-DD format

Examples
2024-06-15
start_dateslack#/types/dateRequired

The date the requested time-off period will start, in YYYY-MM-DD format

Examples
2024-01-17
time_off_typestringRequired

The type of time-off request

Accepted values
VACATIONSICK_LEAVEOTHER

Optional input parameters

is_half_end_daybooleanOptional

If true, the end date of the time-off period is a half day

is_half_start_daybooleanOptional

If true, the start date of the time-off period is a half day

other_timeoff_namestringOptional

A custom name for the time-off request

reasonstringOptional

The reason for the time-off request

Output parameters​

Required output parameters

request_idstringRequired

Time off request ID

statusstringRequired

Request status

Authentication​

End-user authentication

User workflows that include a connector function relying on end-user authentication can only be started with a link trigger.

{
  "deel_access_token": {
    "credential_source": "END_USER"
  }
}

End-user experience: User will be prompted to link their external account via OAuth when they first start the workflow that contains this connector.

Developer experience: Developer does not have to implement authentication in the app.

Usage info​

First, import Connectors from deno-slack-hub into your project's import_map.json file, like this:

import_map.json
{
    "imports": {
      "deno-slack-hub/": "https://deno.land/x/deno_slack_hub@2.2.0/",
      "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.14.2/",
      "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/"
    }
  }

Next, import Connectors at the top of your workflow's definition file:

my_workflow_file.ts
import { Connectors } from "deno-slack-hub/mod.ts";

Finally, add the connector as a step in your workflow just like you would a Slack function.

my_workflow_file.ts
SomeWorkflow.addStep(
  Connectors.Deel.functions.AddTimeOffRequest, {
  //...

🧙🏼 Your admin may need to approve the connector first. If your workspace has been configured to only allow admin-approved apps, the CLI will prompt you to send an admin approval request the first time you try to use a connector that hasn't been approved by an admin yet. While waiting for admin approval, the CLI may report an error like this:

Workflow function X is referring to an unknown step output parameter Y

You can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.