Add to spreadsheet

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

Facts

Add to spreadsheet

Schema:	`Connectors.GoogleSheets.functions.AddSpreadsheetRow`
Service:	Google Sheets

Input parameters

Required parameters

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

spreadsheet_id

string

·Required

The ID of the spreadsheet

Example

"1234567890_abcdefg_1q2w3e4r5t6y7u"

sheet_title

string

·Required

The title of the sheet where the columns can be found

Example

"Prospect emails"

columns

object

·Required

An object where each key is a string containing a numerical index representing a column. The corresponding values are the content associated with the individual cells in those columns. The keys, in this case, serve as string representations of column indices.

Example

{
      "0": "Scott Slacksalot",
      "1": "scott.slacksalot@slack.tld"
    }

Optional parameters

Output parameters

Required parameters

spreadsheet_url

string

·Required

Spreadsheet URL

spreadsheet_id

string

·Required

Spreadsheet ID

timestamp_started

slack#/types/timestamp

·Required

Time when step started

timestamp_completed

slack#/types/timestamp

·Required

Time when step ended

column_values

object

·Required

An object containing the column values of the newly added spreadsheet row

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.

google_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.

Developer authentication

google_access_token: {
    credential_source: "DEVELOPER"
}

End-user experience: User can start a workflow containing the connector (they are not prompted to authenticate).

Developer experience: One of the app's collaborators configures external authentication via the CLI before sharing the app with users.

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.GoogleSheets.functions.AddSpreadsheetRow, {
    // The ID of the spreadsheet
    spreadsheet_id: "1234567890_abcdefg_1q2w3e4r5t6y7u",

    // The title of the sheet where the columns can be found
    sheet_title: "Prospect emails",

    // Add a row to the 'Prospect emails' sheet, with 'Scott Slacksalot' in the first column (zero indexed) and 'scott.slacksalot@salesforce.com' in the second column
    columns: {
      "0": "Scott Slacksalot",
      "1": "scott.slacksalot@slack.tld"
    },

    google_access_token: { credential_source: "END_USER" }
  }
);

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