Signi
The Signi modules allow you to create, update, send, retrieve, list, and delete the contracts in your Signi account.
Getting Started with Signi
Prerequisites
- A Signi account - create an account at app.signi.com/register.
The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!
Connecting Signi to Integromat
1. Log in to your Signi account.
2. 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.
3. 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.
4. Copy the API key to your clipboard.
5. Go to Integromat and open the Signi module's Create a connection dialog.
6. In the Connection name field, enter a name for the connection.
7. In the API Key field, enter the API key copied in step 4, and click Continue.
The connection has been established.
Actions
Get a Contract
Returns details about a contract specified by ID.
Connection | Establish a connection to your Signi account. |
Contract ID | Select or map the Contract ID whose details you want to retrieve. |
With | Select or map the fields whose details you want to view in the contract information. For example, files. |
Delete a Contract
Deletes a contract specified by ID.
Connection | Establish a connection to your Signi account. |
Contract ID | Select or map the Contract ID you want to delete. |
Delete Completely including all attachments | Select the checkbox you want to delete all the attachments associated with the contract. |
Download a PDF
Retrieves a PDF of a contract specified by ID.
Connection | Establish a connection to your Signi account. |
Contract ID | Select or map the Contract ID which you want to download as PDF. |
Get a Contract Revision List
Retrieves a PDF with the contract history.
Connection | Establish a connection to your Signi account. |
Contract ID | Select or map the Contract ID whose revision history changes you want to retrieve. |
Create a Contract Preview from Template
Creates a (partly) filled template and returns an HTML preview of the contract.
Connection | Establish a connection to your Signi account. |
Template ID | Select or map the Template ID to apply for the contract preview that you want to create. |
Parameters | 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. |
Make an API Call
Performs an arbitrary authorized API call.
Connection | Establish a connection to your Signi account. |
URL | Enter a path relative to https://api.signi.com/api For example: /v1/me For the list of available endpoints, refer to the Signi API Documentation. |
Method | Select the HTTP method you want to use: GET POST PUT PATCH DELETE |
Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String | Enter the request query string. |
Body | Enter the body content for your API call. |
Example of Use - Get Account Information
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:
Create a Contract from Template
Creates a contract from a template with optional attachments.
Connection | Establish a connection to your Signi account. | ||||||||||||||||||||||||||||||||
Contract Number | Enter (map) the contract number. | ||||||||||||||||||||||||||||||||
Save as Draft | Select the checkbox if you want to save this contract as a draft. | ||||||||||||||||||||||||||||||||
Locale | Select or map the language for the contract. For example, EN for English. | ||||||||||||||||||||||||||||||||
People | Add the people to the contract:
| ||||||||||||||||||||||||||||||||
ID | Select or map the Template ID you want to apply to the contract. | ||||||||||||||||||||||||||||||||
Parameters | Add the parameters IDs and their value that you want to add to the contract. | ||||||||||||||||||||||||||||||||
Webhooks | Add the webhooks: State Select or map the status of the webhook:
Enter (map) the webhook's URL address. | ||||||||||||||||||||||||||||||||
Attachments | Add the attachments related to the contract: People ID Parameters | ||||||||||||||||||||||||||||||||
Signing Order | Select or map the signing order option for the contract:
| ||||||||||||||||||||||||||||||||
Auto sign Proposers | Entertrue for the auto sign, otherwise, enter a location. | ||||||||||||||||||||||||||||||||
Missing Positions | Select or map an option to handle persons without signature positions. |
Create a Contract from Document
Creates a contract from a document with optional attachments.
Connection | Establish a connection to your Signi account. |
Contract | Enter the contract details: Filename Data |
Signing Order | Select or map the signing order option for the contract:
|
People | Add the people related to the attachment: Email Contract_role Positions |
Webhooks | Add the webhooks: State Select or map the status of the webhook:
Enter (map) the webhook's URL address. |
Attachments | Add the attachments related to the contract: Filename Data People
Signature Position |
Searches
List Contracts
Retrieves a list of all contracts for the account or a specified counterparty.
Connection | Establish a connection to your Signi account. |
Select which results to return | Select or map the option to list the contract results:
|
Counterparty Email | Enter (map) the email address of the counterparty whose contracts you want to list. |
Filter result by state | Select or map the contract status you want to list:
|
Number of results to return | Set the maximum number of contracts Integromat should return during one execution cycle. |
List Templates
Retrieves a list of templates to complete the data and signature.
Connection | Establish a connection to your Signi account. |
Number of results to return | Set the maximum number of templates Integromat should return during one execution cycle. |