Oneflow Actions (Zapier)

Add a Oneflow action

A wide range of Oneflow Action events can be added as actions to a Zap.

To add a Oneflow action to your Zap, follow these steps.

1. Log in to Zapier.
2. Click on + Create Zap.
3. Add a trigger event of your choice.
4. Test your trigger to make sure it works.
5. Click on the Action card to configure it.

6. Search for Oneflow by typing it in the search field and select it.

   

7. Select an Action event from the events dropdown.

   

8. Connect to your Oneflow account.

   NOTE To connect a Oneflow account to Zapier, you'll require a Oneflow token. For more information on how to obtain a Oneflow token, see Getting started with Oneflow x Zapier.

9. Add the required inputs (parameters) for the action.

   NOTE Refer to the sections below for more details on the required inputs for each Oneflow action.

10. Test the action.
11. Publish your Zap.

Any input field can also be set using a custom value from a previous action's output, by clicking on the Custom tab in the same field. For example, in the Add Participant action, you can map the participant's name and email to contact details obtained from a previous step in Zapier (like a CRM trigger).

Create contract

Action inputs

This action is dedicated to creating a new contract by providing the necessary attributes. The workspaces and templates are loaded according to the previously selected Oneflow account.

Action output

Once the contract is successfully created, the following output is displayed.

Apart from the above contract-related data fields, Contract data fields and Party data fields are listed similarly to the 'get contract details' action’s output.

Add an attachment or expanded PDF

Use this action to add an attachment (like a PDF) to an existing contract.

Action inputs

The following are the input fields related to the Add Attachments or Expanded PDF action.

Action output

When the above input attributes are provided and the action is run successfully, the following output is obtained (for both attachment types).

uploadStatus: success

• You may also access a list of additional fields to retrieve from a prior event (trigger or action) by clicking the ‘Custom’ tab.

Add participant

This action is used to add a new participant to an existing Oneflow contract. Once a Zap with this action runs, a new participant with the provided details is added to the specified contract.

Action inputs

The following are the inputs for the ‘Add participant’ action.

Action output

When this action is triggered/tested and is successful, the following output is obtained.

participantId: 126797
participantEmail: abc+test1@oneflow.com
Permission: true
deliveryChannel: email
deliveryStatus: success
identificationNumber: null
myParticipant: false
Name: Test Name
Organizer: false
createdTime: 2022-11-11T15:12:50+00:00
firstVisitedTime: null
lastVisitedTime: null
updatedTime: 2022-11-11T15:12:50+00:00
Visits: 0
phoneNumber:
signMethod: standard_esign
signState: undecided
signStateUpdatedTime:null
signatory: true
title:
twoStepAuthenticationMethod: none

The following table contains the explanation of each of the above output attributes.

Add product

This action is used to add a new product to a table in an existing Oneflow contract. Once a Zap with this action runs, a new product with the provided details is added to the specified table in the contract. Note: When using this action, ensure that the template you select during contract creation contains a product table.

Action inputs

The following are the inputs for the ‘Add product’ action.

Action output

When this action is triggered/tested and is successful, the following output is obtained.

counterpartyLock: false
description: "Single ruled, 200 pages book"
id: 248665
name: "Book"
price_1BaseAmount: 200.00
price_1DiscountAmount: 2.00
price_1DiscountPercent: 0.000
price_2BaseAmount: 210.00
price_2DiscountAmount: 0.00
price_2DiscountPercent: 5.000
quantityAmount: 2
quantityType: "quantity"

The following table contains the explanation of each of the above output attributes.

Delete contract

This action is used to delete an existing contract from Oneflow.

Action inputs

The following are the inputs for the ‘Delete Contract’ action.

Action output

If the action runs successfully, the specified contract is deleted from Oneflow and the 'delete' status is notified.

deleteStatus: success

Download contract

This action is used to download files from an existing Oneflow contract.

Action inputs

The following is the input for the ‘Download Contract’ action.

Action output

When this action is run, a downloadable link to the contract is provided.

The following table contains the explanation of each of the above output attributes.

The downloaded contract file includes all attachments and signature files (if the contract is signed) that were attached to the contract.

Get contract details

This action is used to retrieve the details of an existing Oneflow contract.

Action inputs

The following are the inputs of the ‘Get Contract Details’ action.

In addition to the above-required parameters, the following data fields can be retrieved optionally as additional fields, allowing users to get all the contract and party-related data.

Data fields are contract variables (also known as placeholders, custom fields, tags, etc.) that you can use in product tables, text, images, and form sections within a Oneflow contract.

1. Contract Data Fields
2. Party Data Fields
3. Contract Lifecycle Fields
4. Contract Products

Action output

When the Get contract details action is tested or run, the following contract attributes are retrieved in the output (without contract/party data fields/Contract Lifecycle Fields).

Contract Products

• This action retrieves the product information from a product table in a contract. A maximum of 3 product tables are supported per contract with each product table containing a maximum of 10 products. The following product attributes will be retrieved

product table - 1 - id
65873216
product table - 1 - column - 1 - label
Product
...

Send contract

This action sends or publishes a contract that already exists in Oneflow to its participants. The Send contract action allows you to invite participants to sign or view the contract.

Action inputs

Action output

Once the details are specified and the contract is sent successfully, a link to the published contract is provided. This link can be used to access and view the contract in Oneflow.