API docs by Redocly

Hellosign API (1.0.0)

Download OpenAPI specification:Download

License: Eclipse Public License - 2.0

Access information on Eclipse Foundation Hellosign paperwork.

Hellosign Signature Request

Hellosign signature list

List of Hellosign signature requests created through this API.

Authorizations:
openId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Hellosign signature

Creates a new Hellosign signature request, given the parameters passed in the request body.

Authorizations:
openId
Request Body schema: application/json
required

Parameters for creating Hellosign signature request jobs

required
Array of objects

List of users that will be added as signers for the new document

template_name
required
string

The name of the Hellosign template to create signature requests for

subject
string or null

The subject of the message to the user in the signature request

message
string or null

The message to include with the signature request

Responses

Request samples

Content type
application/json
{
  • "signers": [
    ],
  • "template_name": "string",
  • "subject": "string",
  • "message": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Hellosign signature

Returns a specific Hellosign signature request that was created through this API if it exists.

Authorizations:
openId
path Parameters
id
required
string

The id of the Hellosign signature request to retrieve

Responses

Response samples

Content type
application/json
{
  • "request_id": "string",
  • "hellosign_signature_id": "string",
  • "template_name": "string",
  • "title": "string",
  • "subject": "string",
  • "message": "string",
  • "response": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "events": [
    ]
}

Hellosign signature document

Retrieves a cached version of the Hellosign document and returns the file to the user

Authorizations:
openId
path Parameters
id
required
string

The id of the Hellosign signature request to retrieve

Responses

Document signature templates

Returns list of currently available templates for document signature through this API.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Hellosign Event Callbacks

Hellosign Events callback

Callback URL that will be registered with Hellosign for recieving updates on changes to signature requests created through this API.

Responses

Response samples

Content type
plain/text
Hello API Event Received