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.

Copy a file

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

Facts

Copy a file

Schema:	`Connectors.BoxCore.functions.CopyFile`
Service:	Box

Input parameters

Required parameters

box_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" }

file_id

string

·Required

The ID of the file to copy. Note that it can take up to 10 minutes for a newly-created file to be searchable

Example

"1010101"

Optional parameters

parent_folder_id

string

·Optional

The ID of the destination folder where the file should be copied

name

string

·Optional

If provided, will overwrite the name of the copied file

Output parameters

Required parameters

id

string

·Required

web_link

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.

box_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.BoxCore.functions.CopyFile, {
    box_access_token: { credential_source: "END_USER" },

    // The ID of the file to copy. Note that it can take up to 10 minutes for a newly-created file to be searchable
    file_id: "1010101",

    // (Optional) The ID of the destination folder where the file should be copied
    // parent_folder_id: "1010101",

    // (Optional) If provided, will overwrite the name of the copied file
    // name: "Q4 Results (SE team)"
  }
);

🧙🏼 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.