Send an envelope

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

Facts

Send an envelope

Schema:	`Connectors.Docusign.functions.SendEnvelope`
Service:	DocuSign

Input parameters

Required parameters

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

subdomain

string

·Required

Your DocuSign subdomain

Example

"SomeCorp"

account_id

string

·Required

The globally unique DocuSign account identifier of the user with permissions to make the request

Example

"1234567890"

template_id

string

·Required

The document template ID to use for this envelope

Example

"3ec16e48-9b2c-4577-9984-d20cdd8afe20"

recipient_role

string

·Required

The role name associated with the recipient. Required when working with template recipients.

Example

"AuthorizedSiteBuyer"

recipient_name

string

·Required

Full legal name of the recipient (100 characters max)

Example

"Sandra Slacksalot"

recipient_email

string

·Required

The recipient's email where they will receive the signature notification email

Example

"sandra.slacksalot@slack.tld"

Optional parameters

Output parameters

Required parameters

envelope_id

string

·Required

The ID of the sent envelope

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.

docusign_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

docusign_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.Docusign.functions.SendEnvelope, {
    // Your DocuSign subdomain
    subdomain: "SomeCorp",

    // The globally unique DocuSign account identifier of the user with permissions to make the request
    account_id: "1234567890",

    // The document template ID to use for this envelope
    template_id: "3ec16e48-9b2c-4577-9984-d20cdd8afe20",

    // The role name associated with the recipient. Required when working with template recipients.
    recipient_role: "AuthorizedSiteBuyer",

    // Full legal name of the recipient (100 characters max)
    recipient_name: "Sandra Slacksalot",

    // The recipient's email where they will receive the signature notification email
    recipient_email: "sandra.slacksalot@slack.tld",

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