Dropbox Sign
Request signatures and track signed sales documents via the Dropbox Sign (formerly HelloSign) REST API.
This tool talks to https://api.hellosign.com/v3 using the standard library
only (no third-party packages). It is a thin, deterministic wrapper: each
operation makes one HTTP call and returns the raw Dropbox Sign response body
plus the HTTP status code.
What it does
- Send a signature request for a sales document (contract, order form, proposal) from a public file URL or from a saved Dropbox Sign template.
- Track the status of a signature request (who has signed, when it was completed).
- List recent signature requests and your reusable templates.
Operations
| operation | method + endpoint | required inputs | optional inputs |
|---|---|---|---|
send_signature_request |
POST /signature_request/send (or /send_with_template when templateIds is set) |
signerEmail, and one of fileUrl / templateIds |
signerName, subject, message, testMode |
get_signature_request |
GET /signature_request/{id} |
signatureRequestId |
— |
list_signature_requests |
GET /signature_request/list |
— | page, pageSize |
list_templates |
GET /template/list |
— | page, pageSize |
Every run prints a JSON envelope:
{ "status": "200", "result": "<raw Dropbox Sign JSON as a string>" }
On bad input or a transport failure it prints {"error": "..."} and exits 1,
which fails the InTouch step.
API key setup
- Sign in to the Dropbox Sign dashboard.
- Go to Settings → API → API Keys.
- Create (or copy) an API key.
- Pass it to the tool as the
apiKeyinput.
Authentication is HTTP Basic: the API key is sent as the Basic-auth username with an empty password — exactly as Dropbox Sign documents. A single API key is all that is required; no OAuth flow or token exchange is involved.
Use testMode: "true" while integrating — test-mode requests are free and are
not legally binding.
Examples
Send a contract for signature from a file URL:
operation: send_signature_request
apiKey: <your-api-key>
fileUrl: https://example.com/contracts/acme-order-form.pdf
signerEmail: [email protected]
signerName: Dana Buyer
subject: Please sign your Acme order form
message: Countersigned copy will follow once complete.
testMode: true
Send from a saved template:
operation: send_signature_request
apiKey: <your-api-key>
templateIds: abc123templateid
signerEmail: [email protected]
signerName: Dana Buyer
Check the status of a request:
operation: get_signature_request
apiKey: <your-api-key>
signatureRequestId: fa5c8a0b0f492d768749333ad6fcc214c111e967
List recent signature requests:
operation: list_signature_requests
apiKey: <your-api-key>
page: 1
pageSize: 20
List templates:
operation: list_templates
apiKey: <your-api-key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
errorresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: send_signature_request, get_signature_request, list_signature_requests, list_templates |
signatureRequestId |
string | no | — | Signature request id. Required for get_signature_request. |
fileUrl |
string | no | — | Publicly reachable URL of the document to sign (send_signature_request). Provide this OR templateIds. |
templateIds |
string | no | — | Comma-separated Dropbox Sign template id(s) to send instead of a raw file (send_signature_request). Provide this OR fileUrl. |
signerEmail |
string | no | — | Email address of the signer. Required for send_signature_request. |
signerName |
string | no | — | Display name of the signer for send_signature_request (optional but recommended). |
subject |
string | no | — | Email subject for the signature request (optional). |
message |
string | no | — | Email message body for the signature request (optional). |
testMode |
string | no | — | If 'true', send the request in test mode (no charge, not legally binding). Default false. |
page |
string | no | — | Page number for list_signature_requests / list_templates (optional). |
pageSize |
string | no | — | Results per page for list_signature_requests / list_templates (optional, max 100). |