Introduction to connectors
A connector is a component for platforms like Power Automate and Microsoft Logic Apps that lets you build code-free business logic using visual, block-based actions.
Here’s a basic example of a flow:
Execution flows from top to bottom. In this example, we’re integrating the Oneflow connector with Microsoft Dynamics. When a user runs the flow from a contract record in Dynamics, the flow will execute and publish a contract in Oneflow.
Connector components
Actions
The following actions are currently available:
Each action has Input parameters and Output objects that you can use in subsequent steps.
Action reference
Below is a detailed reference for each action, its input parameters, and what it outputs.
Check API availability
Public API request: Check API availability.
Input: None
Output: None (empty object)
Create a contract
Public API request URL: Create a contract.
Input:
| Name | Type | Required | Description |
|---|---|---|---|
| Workspace Id | Dropdown | Yes | |
| Template Id | Dropdown | Yes | |
| Name | String | No |
Output: Outputs a Contract object.
Create a contract participant
Public API request URL: Create a party in a contract, Create a participant
Input:
Participant type: Individual
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes | ID of the contract to add participants to |
| Participant Type | Enum | Yes | |
| Party Country Code | String | No | ISO code of the country |
| Delivery Channel | Enum | Yes | |
| Participant Email | String | Sometimes | Required if a delivery channel or sign method is set to 'email' |
| Participant Identification Number | String | No | |
| Participant Name | String | Yes | |
| Participant Phone Number | String | Sometimes | Required if the sign method is set to 'sms' |
| Participant Sign Method | Enum | Yes | |
| Is Signatory | Boolean | No | |
| Participant Title | String | No | |
| Participant 2FA Method | Enum | No | |
| Can Update Contract | Boolean | Sometimes | Required if 'Is Signatory' is set to true |
Participant Type: Company
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes | ID of the contract to add participants to |
| Party Country Code | String | No | ISO code of the country |
| Delivery Channel | Enum | Yes | |
| Participant Email | String | Sometimes | Required if the delivery channel or sign method is set to 'email' |
| Party Name | String | Yes | |
| Party Identification Number | String | No | |
| Participant Identification Number | String | No | |
| Participant Name | String | Yes | |
| Participant Phone Number | String | Sometimes | Required if the sign method is set to 'sms' |
| Participant Sign Method | Enum | Yes | |
| Is Signatory | Boolean | No | |
| Participant Title | String | No | |
| Participant 2FA Method | Enum | No | |
| Can Update Contract | Boolean | Sometimes | Required if 'Is Signatory' is set to true |
Output: Dynamic output, either a Participant or Party object.
Delete a contract
Public API request URL: Delete a contract by ID
Input:
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes |
Output: None (empty object)
Download a contract file by ID
Public API request URL: Get a contract file by ID
Input:
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes | |
| File Id | Integer (Enum) | Yes | 1 - contract file 2 - verification |
Output: Outputs file content in byte array format.
Get a contract status
Public API request URL: Get a contract by ID
Input:
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes |
Output:
| Name | Type | Description |
|---|---|---|
| State | String | Status of the contract |
| State Updated Time | DateTime | When the status of the contract was updated |
| Contract’s Updated Time | DateTime | When the contract was last updated |
Publish a contract
Public API request URL: Publish a contract by ID
Input:
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes | |
| Publish Notification Subject | String | Yes | |
| Publish Notification Message | String | Yes |
Output: Contract model
Upload attachments
Public API request URL: Upload attachments
Input:
| Name | Type | Required | Description |
|---|---|---|---|
| Contract Id | Integer | Yes | |
| File | Byte Array | Yes | Contents of the file |
| File (file name) | String | Yes | File name (with file extension) |
| Upload As | Enum | Yes | expanded_pdf or attachment |
Output: None (empty object)
Create connections
When a connection is created, it asks for an email address and API Token:
This connection can then be applied to any actions using the Oneflow connector.
The entered email is set as the `x-oneflow-user-email` header with each API call. The following policy handles that:
|
NOTE The API key is applied with regular functionality without requiring additional policy setup. |