Oneflow
Be more effective with truly digital contracts that make work faster, and life easier. Automate your contract management process with Oneflow
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Oneflow AB |
| URL | https://support.oneflow.com/ |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Oneflow AB |
| Website | https://oneflow.com |
| Privacy policy | https://oneflow.com/privacy-notice/ |
| Categories | Sales and CRM;Productivity |
Oneflow
Be more effective with truly digital contracts that make work faster and life easier. Automate your contract management process with Oneflow.
Publisher: Oneflow AB
Prerequisites
To use the Oneflow connector, you need an active Oneflow admin account. If you don’t have an account yet, go ahead and create a trial account.
Supported operations
Actions
Create contract
Create a contract from a selected template.
Add participant to contract
Add an individual or a company-based participant to an existing contract.
Delete contract
Delete a contract.
Add attachments to contract
Add an expanded PDF or a regular attachment to an existing contract.
Publish contract
Send a contract to all signatories through a specified delivery channel.
Download contract files
Download a PDF copy of a signed contract and any attachment or verification file of an existing contract.
Ping Oneflow API
Check Oneflow API availability.
Triggers
Underway.
Obtaining credentials
To get the Oneflow connector credentials:
Log in to your Oneflow account and proceed to Admin > Account > Extension > API Tokens.
Click Generate a new token in this extension and paste the token into the connection wizard in your Power Automate Flow.
Known issues and limitations
Currently, there are no known issues or limitations specific to the Oneflow connector.
Contact us
Our website: https://oneflow.com/
Customer support: https://support.oneflow.com
Sales and pricing: https://oneflow.com/contact/
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Oneflow API key | securestring | The Api Key for this api | True |
| Email address | string | Oneflow user email address | True |
| API URL | string | Select the environment you want to connect to. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add Participant |
Add participant to the contract |
| Add product to a contract |
Add a product to an existing product group in a contract. |
| Create a contract |
Create a new contract based on the selected template. |
| Delete a contract |
Delete a specific contract by its ID. |
| Download a contract file |
Retrieve a specific contract file by its ID. |
| Get contract details |
Retrieve the details of a contract by its ID. |
| Get the status of a contract |
Retrieve the status of a specific contract by its ID. |
| Ping |
Use this endpoint to check if the Oneflow API is available. |
| Publish a contract |
Sends contract to participants for signing. |
| Update a datafield |
Update a datafield in the specific contract by its ID. |
| Upload attachments |
Add attachment or a PDF document to a contract. |
Add Participant
Add participant to the contract
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
|
Add As
|
x-oneflow-user-email-override | string |
Select user to execute this action as, or enter a custom email |
|
|
Participant Type
|
participant_type | True | string |
Individual/Company |
|
party
|
party | True | dynamic |
Returns
- response
- object
Add product to a contract
Add a product to an existing product group in a contract.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
x-ms-oneflow-contract_id | True | integer |
Contract Id |
|
Product group
|
x-ms-oneflow-product-group-index | True | integer |
Select the product table index to add the products to. Ordered from top to bottom in the contract. |
|
Product Locked For Counterparties?
|
counterparty_lock | boolean |
Select whether you want the product attributes to be editable by counterparties. |
|
|
Product Description
|
description | string |
Add details about the product. |
|
|
Product Name
|
name | string |
Name of the product. |
|
|
Amount
|
amount | string |
Base amount for the product. |
|
|
Discount Amount
|
amount | string |
Discount amount as a number. |
|
|
1 Discount Percent
|
discount_percent | string |
Discount as a percentage of the base amount. |
|
|
Amount
|
amount | string |
Secondary price value. i.e. if the product has a subscription fee. |
|
|
Discount Amount
|
amount | string |
Secondary discount amount as a number. |
|
|
2 Discount Percent
|
discount_percent | string |
Secondary discount amount as a percentage of Price 2. |
|
|
Amount
|
amount | integer |
Any positive number or 1/0 if the type is multiple_choice/single_choice |
|
|
Product Type
|
type | string |
Select an input type of quantity (i.e. a checkbox, number, single select). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Contract state
|
state | string |
draft/pending/overdue/signed/declined |
|
Contract state update time
|
state_updated_time | string | |
|
Contract update time
|
updated_time | string |
Create a contract
Create a new contract based on the selected template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Create as
|
x-oneflow-user-email |
Specify Oneflow user email. Action will create contract as this user. |
||
|
Contract name
|
name | string | ||
|
Workspace name
|
workspace_id | True | integer |
Select a Workspace for your contract |
|
Template name
|
template_id | True | integer |
Select a template to create your contract from |
|
Datafield
|
custom_id | True | string |
Select datafield to populate |
|
Value
|
value | string |
Datafield value |
Returns
- Body
- Contract
Delete a contract
Delete a specific contract by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
|
Delete As
|
x-oneflow-user-email-override | string |
Select user to execute this action as, or enter a custom email |
Returns
- response
- string
Download a contract file
Retrieve a specific contract file by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Download As
|
x-oneflow-user-email-override | string |
Select user to execute this action as, or enter a custom email |
|
|
Contract Id
|
contract_id | True | string |
Contract Id |
|
File Id
|
file_id | True | string |
Type of file: * 1 - Contract PDF * 2 - Verification |
Returns
- File Content
- binary
Get contract details
Retrieve the details of a contract by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
Returns
- Body
- Contract
Get the status of a contract
Retrieve the status of a specific contract by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Contract state
|
state | string |
draft/pending/overdue/signed/declined |
|
Contract state update time
|
state_updated_time | string | |
|
Contract update time
|
updated_time | string |
Ping
Publish a contract
Sends contract to participants for signing.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
|
Subject
|
subject | string |
Notification subject |
|
|
Message
|
message | string |
Notification message |
|
|
Publish As
|
x-oneflow-user-email-override | string |
Select user to execute this action as, or enter a custom email |
Returns
- Body
- Contract
Update a datafield
Update a datafield in the specific contract by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
|
Custom Id
|
data_field_id | True | string |
Custom id (external key) of the datafield. |
|
Update As
|
x-oneflow-user-email-override | string |
Select user to execute this action as, or enter a custom email |
|
|
Value
|
value | string |
Value to set for the datafield. |
|
|
Custom Id
|
custom_id | True | string |
Custom id of the datafield |
Returns
- Body
- Datafield
Upload attachments
Add attachment or a PDF document to a contract.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contract Id
|
contract_id | True | string |
Contract Id |
|
File
|
file | True | binary |
File to upload. File name should be in file.ext format |
|
Upload As
|
upload_as | string |
select type of attachment to upload |
|
|
Execute As
|
x-oneflow-user-email-override | string |
Select user to execute this action as, or enter a custom email |
Returns
- response
- object
Triggers
| When a contract is updated |
Register a webhook for a specified contract update event |
When a contract is updated
Register a webhook for a specified contract update event
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Update type
|
filters | True | array of string | |
|
Template Group Id
|
template_group_id | integer |
(Optional) Filter contracts by a template group. |
Returns
- Body
- Webhook_Event
Definitions
Contract
| Name | Path | Type | Description |
|---|---|---|---|
|
Contract Delete Permission
|
_permissions.contract:delete | boolean |
User can delete contract |
|
Contract name
|
_private.name | string | |
|
Contract value
|
_private.value.amount | string | |
|
Currency
|
_private.value.currency | string | |
|
Contract creation time
|
_private_ownerside.created_time | string | |
|
Can Receive Attachments
|
available_options.can_receive_attachments | boolean |
Contract can receive attachments |
|
Can Receive Expanded PDF
|
available_options.can_receive_expanded_pdf | boolean |
Contract can receive expanded PDF |
|
Contract ID
|
id | integer |
Contract Id |
|
Contract end time
|
lifecycle_state.contract_end_time | string | |
|
Contract start time
|
lifecycle_state.contract_start_time | string | |
|
Contract cancel time
|
lifecycle_state.cancel_time | string | |
|
Contract ended by termination?
|
lifecycle_state.has_ended_by_termination | boolean | |
|
Has notice period start time passed?
|
lifecycle_state.has_passed_notice_period_start_time | boolean | |
|
Is contract canceled
|
lifecycle_state.is_canceled | boolean | |
|
Is contract recurring
|
lifecycle_state.is_recurring | boolean | |
|
Lifecycle state
|
lifecycle_state.lifecycle_state | string |
awaiting/active/ended |
|
Lifecycle state updated time
|
lifecycle_state.lifecycle_state_updated_time | string | |
|
parties
|
parties | array of Party |
Parties collection |
|
Product groups
|
product_groups | array of Product_Group |
product_groups collection |
|
Contract publishing time
|
published_time | string | |
|
Contract signing expiration time
|
signing_period_expiry_time | string | |
|
Contract state
|
state | string |
draft/pending/overdue/signed/declined |
|
Contract state update time
|
state_updated_time | string | |
|
Contract update time
|
updated_time | string |
Party
| Name | Path | Type | Description |
|---|---|---|---|
|
Party country code
|
country_code | string | |
|
Party Identification Number
|
identification_number | string |
Party identification number |
|
Is My Party
|
my_party | boolean |
Contract party is my_party |
|
Party name
|
name | string | |
|
participants
|
participants | array of Participant |
Participants collection |
|
Party type
|
type | string |
company/individual |
|
participant
|
participant | Individual_Participant |
Individual participant object |
Participant
| Name | Path | Type | Description |
|---|---|---|---|
|
Can Participant Update Contract?
|
_permissions.contract:update | boolean | |
|
Participant first visit time
|
_private_ownerside.first_visited_time | string | |
|
Participant Last visit time
|
_private_ownerside.last_visited_time | string | |
|
Participant visit count
|
_private_ownerside.visits | integer | |
|
Participant delivery channel
|
delivery_channel | string |
email/none/same_device/sms |
|
Participant delivery status
|
delivery_status | string |
not_sent/pending/failure/bounce/success/opened |
|
Participant email
|
string | ||
|
Participant identification number
|
identification_number | string |
Participant identification number |
|
Participant is my_participant
|
my_participant | boolean | |
|
Participant name
|
name | string | |
|
Participant is organizer
|
organizer | boolean | |
|
Participant phone number
|
phone_number | string | |
|
Participant sign method
|
sign_method | string |
standard_esign/sms/swedish_bankid/norwegian_bankid/danish_nemid/finnish_bankid |
|
Participant sign state
|
sign_state | string |
undecided/signed/declined |
|
Participant sign state updated time
|
sign_state_updated_time | string |
sign_state_updated_time |
|
Participant is signatory
|
signatory | boolean | |
|
Participant title
|
title | string | |
|
Participant 2FA method
|
two_step_authentication_method | string |
email/sms/none |
Individual_Participant
Individual participant object
| Name | Path | Type | Description |
|---|---|---|---|
|
Individual participant can update contract
|
_permissions.contract:update | boolean |
contract:update permissions for Individual Participant |
|
Individual participant first visit time
|
_private_ownerside.first_visited_time | string | |
|
Individual participant last visit time
|
_private_ownerside.last_visited_time | string | |
|
Individual participant updated time
|
_private_ownerside.updated_time | string | |
|
Individual participant visit count
|
_private_ownerside.visits | integer | |
|
Individual participant delivery channel
|
delivery_channel | string |
email/none/same_device/sms |
|
Individual participant delivery status
|
delivery_status | string |
not_sent/pending/failure/bounce/success/opened |
|
Individual participant email
|
string | ||
|
Individual participant identification number
|
identification_number | string | |
|
Individual participant is my_participant
|
my_participant | boolean | |
|
Individual participant name
|
name | string | |
|
Individual participant is organizer
|
organizer | boolean | |
|
Individual participant phone number
|
phone_number | string | |
|
Individual participant sign method
|
sign_method | string |
standard_esign/sms/swedish_bankid/norwegian_bankid/danish_nemid/finnish_bankid |
|
Individual participant sign state
|
sign_state | string |
undecided/signed/declined |
|
Individual participant sign state updated time
|
sign_state_updated_time | string | |
|
Individual participant is signatory
|
signatory | boolean | |
|
Individual participant title
|
title | string | |
|
Individual participant 2FA method
|
two_step_authentication_method | string |
email/sms/none |
Product_Group
product_group item in product_groups collection
| Name | Path | Type | Description |
|---|---|---|---|
|
Product Group Id
|
id | integer | |
|
Products
|
products | array of Product |
products collection |
Product
| Name | Path | Type | Description |
|---|---|---|---|
|
locked for counterparties?
|
counterparty_lock | boolean |
counterparty_lock |
|
description
|
description | string | |
|
id
|
id | integer | |
|
name
|
name | string | |
|
amount
|
price_1.amount.amount | string |
Amount value of price 1 |
|
base amount
|
price_1.base_amount.amount | string |
Amount value of price 1 |
|
discount amount
|
price_1.discount_amount.amount | string |
Discount amount of price 1 |
|
discount percent
|
price_1.discount_percent | string |
Discount percent of price 1 |
|
amount
|
price_2.amount.amount | string |
Amount value of price 2 |
|
base amount
|
price_2.base_amount.amount | string |
Base amount value of price 2 |
|
discount amount
|
price_2.discount_amount.amount | string |
Discount amount of price 2 |
|
discount Percent
|
price_2.discount_percent | string |
Discount percent of price 2 |
|
amount
|
quantity.amount | integer | |
|
type
|
quantity.type | string |
quantity/multiple_choice/single_choice |
Datafield
| Name | Path | Type | Description |
|---|---|---|---|
|
Datafield id
|
id | number |
Datafield Id |
|
Value
|
value | string |
Datafield value |
|
Datafield description
|
description | string |
Description of the datafield |
|
Datafield name
|
name | string |
Name of the datafield |
|
Datafield placeholder
|
placeholder | string | |
|
Custom Id
|
_private_ownerside.custom_id | string |
Custom id of the datafield |
|
Datafield created time
|
_private_ownerside.created_time | string | |
|
Datafield updated time
|
_private_ownerside.updated_time | string |
Webhook_Event
| Name | Path | Type | Description |
|---|---|---|---|
|
Contract id
|
contract.id | number |
Contract id |
|
Callback id
|
callback_id | string |
Callback id |
|
events
|
events | array of object | |
|
Event created time
|
events.created_time | date-time | |
|
Event id
|
events.id | number | |
|
Event type
|
events.type | string | |
|
Signature
|
events.signature | string |
object
This is the type 'object'.
string
This is the basic data type 'string'.
binary
This is the basic data type 'binary'.