Hubspot

Hubspot allows for external applications to create and update contacts within the Hubspot platform. Currently <form.io> provides form actions to create and update fields within hubspot in various manners. In order to use the Hubspot integration, you will need a Hubspot API key which is only supported on their Professional and Enterprise level plans.

Common integrations between <form.io> and Hubspot are:

  • Creating a contact when a user registers in an application.
  • Setting the contact’s source when a user registers.
  • Updating a timestamp when an action is taken within an application.
  • Incrementing a counter in a counter field when a user performs an action.

All of these and more integrations can be used to add the Hubspot Contact to a marketing list and perform additional followup actions within Hubspot.

API Key

In order to use the Hubspot integration, you will need an API key from Hubspot. To get your API key, you can read their documentation at http://knowledge.hubspot.com/articles/kcs_article/integrations/how-do-i-get-my-hubspot-api-key or get it directly at https://app.hubspot.com/keys/get.

Once you have the key, go to your project settings on form.io and enter the API Key in the Hubspot section.

.

If you add a Hubspot action to a form before setting your API Key, the options will not populate as the information cannot be pulled from Hubspot.

Form Action

The next thing to integrating with Hubspot is to either create a form or select a form to add an action to. Here is an example form:

Then add an action to the form using the Hubspot Action.

The list of fields is the list of editable fields in your Hubspot Contacts. You can add additional contact properties in Hubspot and they will show up in this list.

Use this list to map values from form.io to your hubspot contacts. Contacts are matched first by any fields mapped to the Hubspot Email field. If there is no field on the form mapped to the Email field, the logged in user account is used to find the Hubspot Contact.

Mappings

There are several different ways to map information from form.io to Hubspot. Select the appropriate action for mapping the information.

Map to a form field

This is the simplest form of integration. Select “Map to a form field” in the action field and then select which field on the form you would like to map it to. Values will then populate from the form field to the Hubspot contact property.

Set to a static or rendered value

Sometimes you may want to set a contact property to a specific value such as the name of the conference the form is from. You can do this with the “Set to static or rendered value” and then in the value field, input what you want the field set to.

You can also use this field to render fields from the form if you need to change the information. For example, to {{ item.data.firstname }} would be replaced with the firstname field on the form. This supports all the functionality of nunjucks

Increment a number

Any field in Hubspot that contains a number can be incremented whenever the form action occurs. The Value field is the amount to increment the field by. This can be useful for tracking how many times a user performs some action within the system.

Decrement a number

This field is the opposite of increment.

Set to current Timestamp

If you want to track the last time the user performed some action, you can use the “Set to current datetime” action. This will get the current timestamp and set it in that field in Hubspot.