Skip to main content

KeapProNew in 5.5.6+

This guide assumes you have an Keap account already.

​Compatibility

Uses OAuth flow on v2 of the REST API.

​Endpoints

Maps data to the following endpoints:

  • Contacts

Does your project require something else?   Contact Us

​Fields

Maps data to the following field types:

  • Standard
  • Custom

​Duplicate Check & Update

  • Duplicate detection is based on the email address.

​Setup Instructions

1

​Prepare your site's end for Integration

  • Go to the CRM section in Freeform Settings (Freeform → Settings → CRM).
  • Click the New Integration button at the top right.
  • Select Keap (v1) from the Service Provider select dropdown.
  • Enter a name and handle for the integration.
    • In the OAuth 2.0 Return URI field, a URL will be automatically populated for you. Do not change or adjust this.
  • Copy the URL in the OAuth 2.0 Return URI field to your clipboard.
  • Leave this page open.
2

​Sign up for a Mashery API Management account

3

​Create Mashery API Application

  • After verifying your account, click the create a new application button to begin creating your API app.
  • Fill out the form, and paste the OAuth 2.0 Return URI value from Freeform into the Register Callback URL field in Mashery.
  • Then click the Register Application button.
  • You'll be returned to a page that shows you your client_id and client_secret. Please take note of these and/or leave the browser tab open.
4

​Prepare the Connection

  • Go back to your Craft/Freeform browser tab.
  • Copy the client_id value from Keap and paste it into the Client ID field in Freeform.
  • Copy the client_secret value from Keap and paste it into the Client Secret field in Freeform.
  • Click the Save button.
5

​Finish the Connection

  • You will then be presented an Keap OAuth login form.
  • If not already logged in, enter in your Keap login details and click Log In button.
  • Once logged in, you'll be presented an OAuth form, asking if you want to allow access. Click Allow button.
  • You should now be returned to the Freeform CRM setting page.
  • Confirm that there is a green circle with Authorized in the middle of the page.
6

​Configure the Form

To use this integration on your form(s), you'll need to configure each form individually.

  • Visit the form inside the form builder.
  • Click on the Integrations tab.
  • Click on Keap in the list of available integrations.
  • On the right side of the page:
    • Enable the integration.
    • Select the API endpoints you wish to map to.
    • Map Freeform fields to the Keap fields as needed.
Finished!

For mapping to Provinces or States, you'll map to the Region field. The Region field expects values like US-CA for California state in USA, or CA-MB for Manitoba province in Canada. When mapping to Regions, it's required you map the Country code as well.

Country code mapping uses 3-digit codes like USA for United States of America, CAN for Canada, GBR for United Kingdom, etc.

Please note that if you set this up initially on a development environment, you will need to update your callback URL and reauthorize the connection on your production environment. However, your settings and field mappings will remain intact.

Page Feedback