Skip to main content

Form integration partnership API instructions

How to set up your API so that can Run can build a form integration for it

Updated this week

โš ๏ธ This document is not meant for campaigns using our platform

RUN's Form Builder is an advanced feature we provide to our customers for forms on their campaign websites. We allow campaigns to send form data directly to the tools that we have integrations built for.

What we need from you to add your platform as a destination on our form builder:

  • Sandbox user account for our own testing, plus applicable API keys if we are unable to create them ourselves

  • Endpoint to post form submissions: Usually this is adding "people" records to your database

  • Endpoint to make sure an API key is valid: if the user provides an invalid API key, we want to give that feedback immediately in the Form Builder, otherwise they may assume their form is broken

  • Endpoint(s) to pull methods for segmentation (ex. tags, source codes, etc.). Ideally, do not set a limit on the number of tags that you send via a given API request. Many customers end up exceeding those limits, which then requires us to build tools to submit multiple requests. If you do need to create a limit, 1000 should be safe in most cases.

  • Endpoint to pull custom fields (optional)

As an example, this is our Form Builder set up with NGP as a destination, with a selected source code for segmentation, and a custom input field with a dropdown displaying custom fields in NGP that the field can be linked to.

Did this answer your question?