Create a contract with data fields

Data fields are simply put contract variables. Using data fields, it is possible to send in any text data into a contract and use them in either text and image sections or product descriptions. You can set the data field values either on contract creation or by updating them later.

In the multiple integrations model, a playbook defines the available data fields and maps them to fields from connected integration blueprints. A template can be linked to one playbook and can store values for those fields. You can set values only for data fields available in the selected template.

Step 1. Create a playbook with data fields

To create a playbook, you can follow the process shown below,

1. Go to the Oneflow application Admin > Playbooks tab, and add a playbook. After creating the playbook, you can add data fields to the new playbook.

   

2. You can now create a new playbook and add data fields to it.

   

3. Open Connected integrations and connect the integration blueprints required for your workflow.

   

4. Select how fields from each integration blueprint should be added.

   

   🚧

   Note

   • You can choose "Do not add any fields" when connecting an integration blueprint to your playbook and add fields manually.

5. After configuring a playbook, open the template you want to use and assign the playbook as shown below.

   

6. Confirm that the playbook data fields appear in the template.

   

Step 2. Obtain necessary information

To run the script described in this tutorial, you’ll need the following data:

Step 3. Run the code

Replace the values of the parameters in the following command with the actual data from your account:

curl --request POST \
  --url https://api.oneflow.com/v1/contracts/create \
  --header 'content-type: application/json' \
  --header 'x-oneflow-api-token: API_TOKEN' \
  --header 'x-oneflow-user-email: USER_EMAIL' \
  --data '{"workspace_id": WORKSPACE_ID,"template_id": TEMPLATE_ID, "data_fields": [{"custom_id": "first_name", "value": "Bob"},{"custom_id": "last_name", "value": "Ross"}]}'

import requests

headers = {
    'content-type': 'application/json',
    'x-oneflow-api-token': 'API_TOKEN',
    'x-oneflow-user-email': 'USER_EMAIL',
}

data = {
  "workspace_id": WORKSPACE_ID,
  "template_id": TEMPLATE_ID, 
  "data_fields": [
    {
      "custom_id": "first_name", 
      "value": "Bob"
    },
    {
      "custom_id": "last_name", 
      "value": "Ross"
    }
  ]
}

response = requests.post('https://api.oneflow.com/v1/contracts/create', 
                         headers=headers, json=data)

print(reponse.json())

When setting data fields in the create contract request, you can expect the following behavior:

Expected response

This request will output details about the contract with the data fields you created in the JSON format. The output will be similar to the output of the Create contract request.

Please see the Data field section in the Data model category for more information about the output.

Response codes