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.

Send signature request using a template

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.DropboxSign.functions.SendSignatureRequestWithTemplate`
Service:	Dropbox Sign

Input parameters

Required parameters

dropbox_sign_access_token

slack#/types/credential/oauth2

·Required

Dropbox Sign Credential to use

template_id

string

·Required

The ID of the document template to use for this signature request

Example

"123456"

signer_role

string

·Required

The specific role of this signer based on the provided roles in the associated template ID

Example

"vpsignoff"

signer_name

string

·Required

The name of the signer

Example

"Scott Slacksalot"

signer_email_address

string

·Required

The email address where the signer will be sent the signature request

Example

"scott.slacksalot@salesforce.tld"

Optional parameters

title

string

·Optional

The title of the request

email_subject

string

·Optional

The subject of the email containing the signature request that's sent to the recipient

email_message

string

·Optional

A message added to the body of the signature request email that's sent to the recipient

Output parameters

Required parameters

signature_request_id

string

·Required

Signature request ID

title

string

·Required

Signature request title

subject

string

·Required

Email subject

message

string

·Required

Email message

signing_url

string

·Required

Signature signing URL

details_url

string

·Required

Signature details URL

signer_name

string

·Required

Signer name

signer_email_address

string

·Required

Signature request title

Authentication

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

This connector only supports using the credentials of the user running the workflow, so the credential_source of this connector's access token parameter must be set to "END_USER".

End-user authentication

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

dropbox_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.DropboxSign.functions.SendSignatureRequestWithTemplate, {
  //...

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