HelloSign

HelloSign enables secure electronic signatures that are business-caliber, easy-to-use and legally binding.

Status: Preview

Tier: Premium

Version: 1.0.0

Actions:

Name	Summary
CreateRequest ([Optional]string test_mode, string template_id, [advanced][Optional]string subject, [advanced][Optional]string message, [advanced][Optional]string signing_redirect_url, [advanced][Optional]boolean allow_decline, DynamicSigners signers)	Send signature request from template
GetRequest (string requestId)	Get signature request
ListTemplates ()	List templates
ListSignatureRequests ()	List signature requests
CancelRequest (string requestId)	Cancel signature request
GetDynamicSigners (string template_id)	Get the signers of a template in dynamic schema format

Triggers:

Name	Summary
OnNewRequest ()	When a signature request is created
OnRequestCompleted ()	When a signature request is completed
OnRequestDeclined ()	When a signature request is declined

Objects:

Name	Summary
DynamicSigners
List_templates_Response
RequestResponse

Actions:

CreateRequest

Summary: Send signature request from template

Description: Create and send a new signature request based off an existing template.

Syntax:

HelloSign.CreateRequest ([Optional]string test_mode, string template_id, [advanced][Optional]string subject, [advanced][Optional]string message, [advanced][Optional]string signing_redirect_url, [advanced][Optional]boolean allow_decline, DynamicSigners signers)

Parameters:

Name	Type	Summary	Required	Related Action
test_mode	string (Account type)Values: [Free, Paid]	The type of account, either Free or Paid.	False
template_id	string (Template id)	The unique identifer of the template to create a SignatureRequest from.	True	ListTemplates
subject	string (Subject)	The subject in the email that will be sent to the signers.	False
message	string (Message)	The custom message in the email that will be sent to the signers.	False
signing_redirect_url	string (Redirect URL)	The URL you want the signer redirected to after they successfully sign.	False
allow_decline	boolean (Allow Decline)	Allows signers to decline to sign a document if set to true. Defaults to false.	False
signers	DynamicSigners	An object that represents signers based on a template.	True

Returns:

Type:RequestResponse

GetRequest

Summary: Get signature request

Description: Get a signature request that includes the current status for each signer.

Syntax:

HelloSign.GetRequest (string requestId)

Parameters:

Name

Type

Summary

Required

Related Action

requestId

string

(Request Id)

The id of the request to retrieve

True

ListSignatureRequests

Returns:

Type:RequestResponse

ListTemplates

Summary: List templates

Description: List templates

Syntax:

HelloSign.ListTemplates ()

Returns:

Type:List_templates_Response

ListSignatureRequests

Summary: List signature requests

Description: Lists the SignatureRequests (both inbound and outbound) that you have access to.

Syntax:

HelloSign.ListSignatureRequests ()

Returns:

Type:array of (RequestResponse)

CancelRequest

Summary: Cancel signature request

Description: Cancel an existing signature request.

Syntax:

HelloSign.CancelRequest (string requestId)

Parameters:

Name

Type

Summary

Required

Related Action

requestId

string

(Request Id)

The id of the incomplete request to cancel.

True

ListSignatureRequests

Returns:

GetDynamicSigners

Summary: Get the signers of a template in dynamic schema format

Description: Get the signers of a template in dynamic schema format.

Syntax:

HelloSign.GetDynamicSigners (string template_id)

Parameters:

Name

Type

Summary

Required

Related Action

template_id

string

(Template Id)

True

Returns:

Type:string

Triggers:

Trigger OnNewRequest

Summary: When a signature request is created

Description: Triggers when a new signature request is created.

Syntax:

HelloSign.OnNewRequest ()

Returns:

Type:array of (RequestResponse)

Trigger OnRequestCompleted

Summary: When a signature request is completed

Description: Triggers when a signature request is completed by all parties.

Syntax:

HelloSign.OnRequestCompleted ()

Returns:

Type:array of (RequestResponse)

Trigger OnRequestDeclined

Summary: When a signature request is declined

Description: Triggers when a signature request is decline.

Syntax:

HelloSign.OnRequestDeclined ()

Returns:

Type:array of (RequestResponse)

DynamicSigners

Summary:

Description: An object that represents signers based on a template.

Properties:

Name

Type

Summary

List_templates_Response

Summary:

Description:

Properties:

Name

Type

Summary

templates

array of (TemplatesItem)

templates

TemplatesItem

Summary:

Description:

Properties:

Name

Type

Summary

template_id

string

template_id

title

string

title

RequestResponse

Summary:

Description:

Properties:

Name	Type	Summary
signature_request_id	string Request id	Unique id of the signature request.
title	string Title	Signature request title.
subject	string Subject	Subject of the email sent to signers.
message	string Message	Custom message in the email sent to signers.
is_complete	boolean Is complete	True if the request has been fully executed by all signers.
is_declined	boolean Is declined	True if the request has been declined by a signer.
signing_url	string Signing Url	Url where a signer, after authenticating, can sign the documents.
details_url	string Details Url	Url where the requester and the signers can view the current status of the request.
requester_email_address	string Requester email	Email address of the initiator of the signature request.
signatures	array of (SignaturesItem) Signatures

SignaturesItem

Summary:

Description:

Properties:

Name	Type	Summary
signature_id	string Signature Id	Unique identifier of the signature.
signer_email_address	string Signer Email	Email address of the signer.
signer_name	string Signer Name	Name of the signer.
status_code	string Status Code	Current status of the signature.
signed_at	string(date) Signed Date	Date in ISO UTC format (yyyy-MM-ddTHH:mm:ss.fffZ)
last_viewed_at	string(date) Last Viewed Date	Date in ISO UTC format (yyyy-MM-ddTHH:mm:ss.fffZ)
last_reminded_at	string Last Reminded Date	Date in ISO UTC format (yyyy-MM-ddTHH:mm:ss.fffZ)