Dropbox Sign
Dropbox Sign (formerly HelloSign) is the easiest way to send, receive and manage legally binding electronic signatures.
Dropbox Sign (formerly HelloSign) is the easiest way to send, receive and manage legally binding electronic signatures.
Category: Document Management. Adds 6 actions to a care flow.
What to configure
Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.
| Setting | Required | Notes |
|---|---|---|
| API Key | Yes | Enter an API key so Awell can communicate with the Dropbox Sign API. Stored as a secret. |
| Client ID | Yes | The client ID of the app created in Dropbox Sign. |
| Test mode | No | Set to "Yes" if you want to execute all API calls to DropboxSign in test mode. Set to "No" if you want to disable test mode. Keep in mind that when test mode is disabled, you must upgrade to a paid DropboxSign API plan to create signature requests. Defaults to "No". |
Actions
Dropbox Sign adds these 6 actions to a care flow. Add one to a step, then fill in its inputs.
Cancel signature request
Cancels an incomplete signature request. This action is not reversible.
| Input | Type | Required | Description |
|---|---|---|---|
| Signature request ID | string | Yes | The id of the SignatureRequest to cancel. Please note you can only cancel incomplete signature requests. |
Cancels an incomplete signature request. This action is not reversible.
Create embedded signature request with template
Let a stakeholder sign a request within Awell based off a template. The care flow will not progress until the request is signed.
| Input | Type | Required | Description |
|---|---|---|---|
| Signer role | string | Yes | Must match an existing role in chosen template. It's case-sensitive. |
| Signer name | string | Yes | The name of the signer. |
| Signer email address | string | Yes | The email address of the signer. |
| Template ID | string | Yes | Use the template id to create a SignatureRequest from a template. |
| Title | string | No | The title you want to assign to the SignatureRequest. |
| Subject | string | No | The subject in the email that will be sent to the signer. |
| Message | string | No | The custom message in the email that will be sent to the signer. |
| Custom fields | json | No | An array defining values and options for custom fields. |
Returns:
| Data point | Type |
|---|---|
expiresAt | date |
signatureRequestId | string |
signUrl | string |
Embedded signing
Let a stakeholder sign an embedded signature request with Awell Hosted Pages.
| Input | Type | Required | Description |
|---|---|---|---|
| Sign URL | string | Yes | Enter the sign URL generated via the "Create embedded signature request with template" action |
Returns:
| Data point | Type |
|---|---|
signed | boolean |
Embedded Signing gives users the ability to sign documents directly from Awell Hosted Pages using Dropbox Sign's embedded signing feature. First an embedded signature request with a template is created and then a signing URL is generated for the signature request. Via the signing URL, we can let the user sign the request from within Awell.
Embedded signing behaves as a blocking action where the action is only completed when the signature request is effectively signed.
**In order to add embedded signing, you need to add 2 actions to you care flow:
- First, add the "Create embedded signature request with template" action. This action will create an embedded signature request based on a template and return a sign URL.
- Second, add the "Embedded signing" action. In this action you will have to configure the sign URL you got from the first action.
Please note that the signing URL generated in the first step is only valid for 1 hour.** This means that from as soon as the first action is activated, the user has 1 hour to complete the signing request. When the sign URL has expired, the document cannot be signed anymore and and the process would have to be repeated.
Get signature request
Get details about a signature request.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Signature request ID | string | Yes | The id of the SignatureRequest you want to retrieve the details for. |
Returns:
| Data point | Type |
|---|---|
detailsUrl | string |
message | string |
originalTitle | string |
requesterEmailAddress | string |
signerEmailAddress | string |
signerName | string |
signerRole | string |
signingRedirectUrl | string |
signingUrl | string |
statusCode | string |
subject | string |
title | string |
Returns the SignatureRequest specified by the signature request id parameter.
Send request reminder
Sends an email to the signer reminding them to sign the signature request.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Signature request ID | string | Yes | The id of the SignatureRequest to send a reminder for. |
| Signer email address | string | Yes | The email address of the signer to send a reminder to. |
Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.
Important:
- The email address specified to send the reminder to needs to be an email address of an actual signer linked to the signature request. If not, the action will fail.
- This action can not be used with embedded signature requests.
Send signature request with template
Send a signature request based off a template.
| Input | Type | Required | Description |
|---|---|---|---|
| Signer role | string | Yes | Must match an existing role in chosen template. It's case-sensitive. |
| Signer name | string | Yes | The name of the signer. |
| Signer email address | string | Yes | The email address of the signer. |
| Template ID | string | Yes | Use the template id to create a SignatureRequest from a template. |
| Title | string | No | The title you want to assign to the SignatureRequest. |
| Subject | string | No | The subject in the email that will be sent to the signer. |
| Message | string | No | The custom message in the email that will be sent to the signer. |
| Signer redirect URL | string | No | The URL you want signer redirected to after they successfully sign. |
Returns:
| Data point | Type |
|---|---|
signatureRequestId | string |
Creates and sends a new SignatureRequest based off of a template specified with the template id parameter. The request will be send to specified signer via email. Please note that is a non-blocking action and that the care flow will automatically continue once the request is sent. It won't wait for the actual signing of the request.
To send signature requests via the DropboxSign API you must upgrade to a paid API plan.
Setup and notes
Dropbox Sign (formerly HelloSign) is the easiest way to send, receive and manage legally binding electronic signatures.
Extension settings
In order to set up this extension, you will need to provide the following settings:
- API Key
- Client ID - the id of the API app created in Dropbox Sign. Only required if want to use embedded signature requests.
- Test mode - whether you want to execute all API calls to DropboxSign in test mode. When test mode is enabled, signature requests will not be legally binding. When disabled, keep in mind that you must upgrade to a paid DropboxSign API plan to create signature requests via the extension.
Changelog
Dropbox Sign changelog
Where this page comes from
The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the
platform actually does rather than a description of it.
Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.
DocuSign
DocuSign makes your business faster, simpler and more cost-efficient with electronic agreements. Agree with confidence, with intuitive signing experiences across virtually any device.
Elation
Elation is a clinical-first EHR and patient engagement tool. It's designed for the craft of primary care medicine.