Active with remarks |
---|
This application needs additional settings. Please follow the documentation below to create your connection. |
The Signi modules allow you to create, update, send, retrieve, list, and delete the contracts in your Signi account.
Prerequisites
-
A Signi account – create an account at app.signi.com/register.
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!
-
Log in to your Signi account.
-
Select the workspace for which you want to establish the account and ensure the option Use the API is checked. You can check by navigating to Set Up Workspace > Advanced Settings.
Please Note: You must purchase the API access by writing to sales@signi.com providing the details of the workspace for which you want to enable the API access.
-
Go to Signi API Page. Enter your account password. In the Key API section, under the workspace for which you want to establish the connection, click Show the API key(s) for 120 seconds.
-
Copy the API key to your clipboard.
-
Go to Boost.space Integrator and open the Signi module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API key copied in step 4, and click Continue.
The connection has been established.
Returns details about a contract specified by ID.
|
|
|
Select or map the Contract ID whose details you want to retrieve. |
|
Select or map the fields whose details you want to view in the contract information. For example, files. |
Deletes a contract specified by ID.
|
|
|
Select or map the Contract ID you want to delete. |
|
Select the checkbox you want to delete all the attachments associated with the contract. |
Retrieves a PDF of a contract specified by ID.
|
|
|
Select or map the Contract ID which you want to download as PDF. |
Retrieves a PDF with the contract history.
|
|
|
Select or map the Contract ID whose revision history changes you want to retrieve. |
Creates a (partly) filled template and returns an HTML preview of the contract.
|
|
|
Select or map the Template ID to apply for the contract preview that you want to create. |
|
Add the parameter IDs and their values for the contract.You can get a list of the template’s parameters and their values using the List Templates module. |
Performs an arbitrary authorized API call.
|
|
|
Enter a path relative to For the list of available endpoints, refer to the Signi API Documentation. |
|
Select the HTTP method you want to use:
to retrieve information for an entry
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
to delete an entry. |
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
Enter the request query string. |
|
Enter the body content for your API call. |
The following API call returns all the account information from your Signi account:
URL:
/v1/me
Method:
GET

Matches of the search can be found in the module’s Output under Bundle > Body.
In our example, the current user information is returned:

Creates a contract from a template with optional attachments.
|
|||||||||||||||||||||||||||||||||
|
Enter (map) the contract number. |
||||||||||||||||||||||||||||||||
|
Select the checkbox if you want to save this contract as a draft. |
||||||||||||||||||||||||||||||||
|
Select or map the language for the contract. For example, EN for English. |
||||||||||||||||||||||||||||||||
|
Add the people to the contract:
|
||||||||||||||||||||||||||||||||
|
Select or map the Template ID you want to apply to the contract. |
||||||||||||||||||||||||||||||||
|
Add the parameters IDs and their value that you want to add to the contract. |
||||||||||||||||||||||||||||||||
|
Add the webhooks:
Select or map the status of the webhook:
Enter (map) the webhook’s URL address. |
||||||||||||||||||||||||||||||||
|
Add the attachments related to the contract:
Add the people related to the attachment:
Enter (map) the email address of the person.
Enter (map) the person’s role in the contract.
Add the x, y, and page coordinates to add the people in the contract.
Enter (map) the Template ID to apply for the attachment.
Add the IDs and their values for the contract. |
||||||||||||||||||||||||||||||||
|
Select or map the signing order option for the contract:
|
||||||||||||||||||||||||||||||||
|
Enter |
||||||||||||||||||||||||||||||||
|
Select or map an option to handle persons without signature positions. |
Creates a contract from a document with optional attachments.
|
|
|
Enter the contract details:
Enter (map) the contract file name with extension.
Enter (map) the file data. |
|
Select or map the signing order option for the contract:
|
|
Add the people related to the attachment:
Enter (map) the email address of the person.
Enter (map) the person’s role in the contract.
Add the x, y, and page coordinates to add the people in the contract. |
|
Add the webhooks:
Select or map the status of the webhook:
Enter (map) the webhook’s URL address. |
|
Add the attachments related to the contract:
Enter (map) the attachment filename with extension.
Enter (map) the file data.
Add the people related to the attachment:
Enter (map) the email address of the person.
Enter (map) the person’s role in the contract.
Select or map the contractor role in the attachment:
Add the x, y, and page coordinates to add the person’s signature location in the contract. |
Retrieves a list of all contracts for the account or a specified counterparty.
|
|
|
Select or map the option to list the contract results:
|
|
Enter (map) the email address of the counterparty whose contracts you want to list. |
|
Select or map the contract status you want to list:
|
|
Set the maximum number of contracts Boost.space Integrator should return during one execution cycle. |
Retrieves a list of templates to complete the data and signature.
|
|
|
Set the maximum number of templates Boost.space Integrator should return during one execution cycle. |
Do you need help with something specific regarding Signi?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch