Skip to main content

Custom fields

Don't forget to check out our Make and Zapier Data fields examples once you've read this article!

This feature is not available for Link buttons

The Data fields features allows you to add Pipedrive's fields to your OneClick trigger data. On top of that it presents users the data fields that they are sending, and you can also make the fields required or not allowed to have a value. When needed you can utilize so called "disposable" fields, that are OneClick specific one-time fields. You can also organize your button fields and give users instructions with additional UI elements.

Add fields

First enable the Data fields feature and add field with the Add new data field button. Select your field type and configure the field's behavior:

oc-datafields-1.gif

Pipedrive fields

You can add deal, organization or person fields to your button. The field selection includes Pipedrive standard and custom fields. The field selection also contains some fields that are not user editable (e.g. Total activities, Update time etc.).

Disposable fields

Disposable fields are editable fields within OneClick, and can be filled in by the user before triggering the button. Disposable field values will be one-time, so on the next trigger the value will be empty again. 

Field type

Disposable fields can be type of:

  • Boolean
  • Date
  • Email
  • Number
  • Short text
  • Long text
  • Multi select
  • Single select
  • Users
Field label

The field name, visible to end user

Field key

The field key name which will be used in the button data payload (please read more below). Field keys will be generated automatically based on the label, but can be changed. Please note that keys need to be unique.

Default values

You can set a default field value for all of the disposable field types. Insert or pick a value that will be set as the default in the default value field. If the field type is Users you can select a specific user or the current user (the user who clicks the button).

Options

If your disposable field is type of single or multi select, you need to add the predefined selectable options. Add new options with the Add option button, and delete existing ones with the trash bin icon. You can sort the options with the drag handles on the left hand side of each option:

oc-datafields-2.png

When you have added your options and saved your button, you can come back and see the option's ID values on the right of each option. ID's are convenient if you ever need to change your option label. For example if your automation would just use the option value to see which options are selected, changing the option label would break your automation. When using ID's instead the label would not matter:

Users field type

The Users field type allows a person clicking the button to select a Pipedrive user account from a dropdown list. When user is selected and the button triggered, all information about the Pipedrive user account will be added to the JSON payload, including ID, email, name etc.

Additional elements

Additional elements allows you to customize the UI of your data field button

Please note that an Additional element cannot be the only field type in a button

Header

Select the header font size in the Size dropdown menu and add the header text in the Text field.

Label

Add the label text in the Text field.

Divider

Select the divider color with the Color picker, you can always revert back to the default color with the Set default button.

Required fields

Fields can be marked as required:

oc-datafields-3.png

If a button is triggered with a required field which has no value, the user will be presented with an error message.

image.png

Hidden fields

Disposable fields cannot be marked as hidden

You can mark a data field hidden if you want to get the field value in your button payload, but don't want to present the field and value to the user.

oc-datafields-4.png

If a hidden field is also marked as required and the value is missing when the button is being triggered the data fields view will be presented with an error message indicating which hidden field value is missing.

Hidden and visible fields can be used together to only present some fields to the user and some are passed in the background

Do not allow value

Disposable fields cannot be marked as not to allow value

Fields can be set to not allow a value:

oc-datafields-5.png

If a button is triggered with a not allowed field having a value an error message will be presented. You can define your own custom error message,message (max 50 characters), and if not defined the default error will be "Field must be empty":

image.png

Ordering fields

You can order your data fields by drag & dropping in the Custom field settings:

oc-datafields-6.gif

Field visibility

Data fields are aware of the Pipedrive context, so if your button has for example deal fields enabled but you trigger the button from a Pipedrive organization the deal fields will not be presented. Only a button triggered from a deal can present all 4 field types (deal, organization, person and disposable). A button triggered from an organization or a person can only present fields of it's own type and disposable. It is recommended to use the data fields feature together with the Limit visibility feature to avoid unexpected results.

Using a button with data fields

When you click on a button with data fields, the fields an values will be presented. If the button contains disposable fields you can (or have to) fill them in. When ready click on the button again in the top right corner. If a required field is missing you cannot continue before the field value(s) have been set. If you need to fill in field values go to the deal, person or organization (depending on the field type) and fill in the value, then click on the refresh icon next to the button.

oc-datafields-7.gif

Data sent with button click

When you trigger a button which has data fields enabled, the fields will be added to the JSON payload:

{
  "identifier": "a8087809-f5d1-4f2c-9d4f-9d1103863515",
  "resource": "deal",
  "view": "details",
  "userId": "1814329",
  "companyId": "14342901",
  "selectedIds": "2",
  "theme": "light",
  "fields": {
    "disposable": {
      "message": {
        "default_value": "Default message",
        "field_key": "message",
        "field_label_value": "Your message here",
        "field_name": "Message",
        "field_type": "varchar",
        "field_value": "Your message here",
        "is_hidden": false,
        "is_multiple_users_allowed": false,
        "is_required": false,
        "is_not_allowed": false
      },
      "select": {
        "default_value": null,
        "field_key": "select",
        "field_label_value": "Option 1",
        "field_name": "Select",
        "field_type": "singleSelect",
        "field_value": {
          "name": "Option 1",
          "key": 113
        },
        "is_hidden": false,
        "is_multiple_users_allowed": false,
        "is_required": false,
        "is_not_allowed": false
      }
    },
    "organization": {
      "a4d7266b99ccf61ae76d7b8115badc84ceacf74c": {
        "default_value": null,
        "field_key": "a4d7266b99ccf61ae76d7b8115badc84ceacf74c",
        "field_label_value": "1234567-8",
        "field_name": "Business id",
        "field_type": "varchar",
        "field_value": "1234567-8",
        "is_hidden": false,
        "is_multiple_users_allowed": false,
        "is_required": false,
        "is_not_allowed": false
      }
    },
    "deal": {
      "d925ce0e73d8d3131be057c1641e56cc1c2a8552": {
        "default_value": null,
        "field_key": "d925ce0e73d8d3131be057c1641e56cc1c2a8552",
        "field_label_value": "2024-02-21",
        "field_name": "Due date",
        "field_type": "date",
        "field_value": "2024-02-21",
        "is_hidden": false,
        "is_multiple_users_allowed": false,
        "is_required": true,
        "is_not_allowed": false
      }
    }
  }
}

In the payload, under fields, you will find a collection for each of the field types. In each of these collections you will find an array of fields, identified by the field key.

Please note that the disposable field property field_value will be an array in case of a single or multi select field, containing the selected option name and it's corresponding unique id

Field keys

Pipedrive default field keys are dictated by Pipedrive. You can obtain field keys from the Pipedrive settings (Company settings -> Data fields). Click on the three dots next to your field name and select Copy API key (read more about Pipedrive data fields here).

image.png

Pipedrive custom field keys are hard to remember and recognize, but you can always see the field name in the field_name property (read more below)

Disposable field keys are automatically generated but they can be changed if necessary.

Field label value

The field_label_value property contains the visible value of the field, as seen in Pipedrive

Field name

The field_name property contains the field's name in Pipedrive

Field type

The field_type property contains the Pipedrive or disposable field type

Field value

The field_value property contains the field value. This may be the same as field_label_value, but in some cases (for example single select field) it is the option id

Is required

The is_required property contains the information if it is marked as required in OneClick.

Back to top