This automations page is moving! We've been working hard at building out our tools documentation at tools.slack.dev — the new home of our Deno Slack SDK and Slack CLI docs! You can start using the new docs today, but we'll keep the content on both sites up to date during the transition.

Add a time off request

Connector functions are a new addition to Slack automations. We recommend understanding the systems and APIs you're integrating with before setup.

Facts

Schema:	`Connectors.Deel.functions.AddTimeOffRequest`
Service:	Deel

Input parameters

Required parameters

deel_access_token

slack#/types/credential/oauth2

·Required

Determines whether this connector will use the credentials of the user starting the workflow or the credentials configured by an app collaborator. See the authentication section on this page for details.

Example

{ credential_source: "END_USER" }

contract_id

string

·Required

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

Example

"12345"

time_off_type

string

·Required

The type of time-off request

Example

One of: "VACATION", "SICK_LEAVE", "OTHER"

start_date

slack#/types/date

·Required

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

Example

"2024-01-17"

end_date

slack#/types/date

·Required

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

Example

"2024-06-15"

Optional parameters

reason

string

·Optional

The reason for the time-off request

is_half_start_day

boolean

·Optional

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

is_half_end_day

boolean

·Optional

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

other_timeoff_name

string

·Optional

A custom name for the time-off request

Output parameters

Required parameters

request_id

string

·Required

status

string

·Required

Authentication

A connector's access token property specifies how the connector handles authentication.

End-user authentication

user Workflows that include a connector function relying on end-user authentication can 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 app.

How to use

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

{
  "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 built-in Slack function.

SomeWorkflow.addStep(
  Connectors.Deel.functions.AddTimeOffRequest, {
    deel_access_token: { credential_source: "END_USER" },

    // The ID of the contract related to the employee requesting time off
    contract_id: "12345",

    // The type of time-off request
    time_off_type: One of: "VACATION", "SICK_LEAVE", "OTHER",

    // The date the requested time-off period will start, in <code>YYYY-MM-DD</code> format
    start_date: "2024-01-17",

    // The date the requested time-off period will end, in <code>YYYY-MM-DD</code> format
    end_date: "2024-06-15",

    // (Optional) The reason for the time-off request
    // reason: "Getting married",

    // (Optional) If true, the start date of the time-off period is a half day
    // is_half_start_day: false,

    // (Optional) If true, the end date of the time-off period is a half day
    // is_half_end_day: false,

    // (Optional) A custom name for the time-off request
    // other_timeoff_name: "December PTO request"
  }
);

🧙🏼 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... is referring to an unknown step output parameter...

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