create_sign_request
Facts
Connectors.BoxSign.functions.CreateSignRequestBox SignInput parameters
Required input parameters
box_access_tokenslack#/types/credential/oauth2RequiredBox Access token. See the authentication section for details.
parent_folder_idstringRequiredThe ID of the folder where signing template exists
1010101signer_emailstringRequiredThe email address to which this sign request will be sent
scott.slacksalot@salesforce.tldtemplatestringRequiredThe ID of the template to use for this sign request
123456Optional input parameters
email_messagestringOptionalA message added to the body of the sign request email that's sent to the recipient
email_subjectstringOptionalThe subject of the email containing the sign request that's sent to the recipient
namestringOptionalName of the request
Output parameters
Required output parameters
idstringRequiredID
Optional output parameters
email_messagestringOptionalEmail message
email_subjectstringOptionalEmail subject
namestringOptionalRequest name
statusstringOptionalRequest status
Authentication
End-user authentication
User workflows that include a connector function relying on end-user authentication 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 the app.
Usage info
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:
import { Connectors } from "deno-slack-hub/mod.ts";
Finally, add the connector as a step in your workflow just like you would a Slack function.
SomeWorkflow.addStep(
Connectors.BoxSign.functions.CreateSignRequest, {
//...
🧙🏼 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 X is referring to an unknown step output parameter YYou can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.