HubSpot: Export data via REST API

Ion integrates seamlessly with HubSpot via their REST API. Ion's HubSpot integration enables you to add contacts to HubSpot in real-time. This document provides step-by-step instructions to set up and start leveraging a HubSpot integration.

Before we begin

There are a few steps you'll need to take in ion prior to setting up the integration, listed below:

Check out the "Before you begin" support post for guidance in creating these items.

  • Create data collection fields
  • Create ion form(s)
  • Set-up testing creative

Let’s Get Started!

1. Add HubSpot account credentials to ion

  1. Click the Integrations tab in your ion console’s side nav
  2. Click “Set up account credentials” toward the top of the screen
  3. Under "HubSpot", click “New HubSpot credential”
  4. Add a friendly label for your account
  5. Save
  6. You will be redirected to HubSpot to authenticate your credentials
  7. After signing into HubSpot, click the Grant access button to allow the Ion platform to access your HubSpot account
  8. After granting access, you will be returned to your Ion console.

2. Create field mapping

Taking the steps below will map your ion data collection fields to their corresponding HubSpot API field names. To get started, add a new field mapping:

  1. Navigate into the Integrations screen
  2. Click the green “New field mapping” button
  3. Label the field mapping and optionally add a description
  4. From the Integration type menu, select “HubSpot”
  5. Select your HubSpot credentials from the credentials dropdown menu
  6. Save

3. Add Outbound fields to field mapping

Outbound fields define the data you extend from ion to HubSpot.

  1. Click the green “New outbound field” button
  2. Add a field by selecting the field type from the source dropdown
    • To add a form field, hidden field or query string variable, select “Data field” and pick the data field category then the data collection field
    • OR, to add an ion Core field, select Core Field then pick the field you seek to include
    • OR, to export multiple ion fields to one external field, pick Mashup and plug inside {{DataName1}} {{DataName2}} etc. into the editor
    • OR, to reformat a value prior to export, pick Javascript code and add logic around the value collected in ion. To access data collection fields via Javascript, use respondent.dataname.
  3. Optionally make your field required to run the integration
  4. Optionally add a default value
  5. Select the HubSpot field from the dropdown menu on the right side of the screen
  6. Save
  7. Repeat these steps for each field that should be included in the Field Mapping
  8. Skip adding Inbound fields

4. Create integration

  1. Navigate back to your Integrations screen
  2. Click into the Integrations tab
  3. Click green “New integration” button
  4. Enter label
  5. Optionally add a description
  6. Select the Field Mapping you’ve just created
  7. Set maximum retries
    • If there is a service interruption with the external platform, Ion will retry the post on the top of the hour for as many retries as you indicate here.
  8. Select Add Lead as the API method
  9. Optionally add yourself to the debug distribution list for testing
    • This will deliver an email to the designated address when the integration runs that displays the request and response from HubSpot

5. Create integration

    The Ion platform runs the integration based on rules you create. Rules can be added to any actionable item in your Ion creative. Integration rules are typically run at the form-level, upon form submission, or on an assessment step. Follow the steps below to add the integration to your ion pages.

    1. Navigate into the creative
    2. Click on the form, button or link you seek to make the trigger to run your integration
    3. In Creative Studio, click on +rules
    4. Select the condition that needs to be met to run the integration
      • “No conditions required” is typically used
    5. Select “Run integration” then select your HubSpot integration as the action
    6. Save

    6. Test integration

    To test your integration, use the creative you set up prior to beginning the integration steps. Please note, integrations do not run in Preview Mode so you'll want to open a URL for testing. The integration will run once you submit the ion form, or complete the action that runs the integration rule. If you’re on the debug email distribution list, you’ll receive an email that displays the data you transferred and the response from HubSpot. You’ll also want to verify success by ensuring the lead was created in your HubSpot instance.

    Nice work!

    Once you’ve completed these steps, your integration is ready for use. You can add the rule to run the integration on all applicable creatives. If you encounter any issues, please reach out to the Support team.