Interactions API Overview

If you are new to the Interactions API, start here!

About

  • The MIG Interactions API is MIG's next generation API platform to facilitate the movement of voter and supporter outreach data.
  • The Interactions API is focused on performant collection and distribution of various types of voter contact data with a focus on flexibility in data models, speed of delivery, and simplicity of usage.
  • The Interactions API allows organizations to move their voter and supporter outreach data from one Source to multiple Destinations in more expansive data formats within seconds.
  • The Interactions API is currently in a private beta and is invite-only. To get access, reach out to [email protected].

What does the Interactions API support?

The Interactions API supports three main types of users:

  • Data owners: Users of tools that engage with the Interactions API either as Sources or Destinations. Data owners are typically organizations, campaigns, and individuals that are generating the data being moved around by the Interactions API.

    • Data owners are responsible for requesting MIGKeys that they share with Sources to send data on their behalf. Data owners are also responsible for ensuring that their MIGKeys are configured correctly i.e., have the correct Destination(s) assigned to Keys.

  • Sources: Applications / tool vendors that send data to the Interactions API on behalf of data owners. Sources can be applications focused on texting, email, phone-banking, digital, canvassing, fundraising, relational organizing, or any other type of outreach.

    • Sources are responsible for maintaining integrations to send data to the Interactions API, correctly utilizing and securing MIGKeys, meeting agreed upon-limits to volume, and formatting requests to the API in at least one of the accepted formats. Sources receive API status codes from the Interactions API and can request additional logs for their traffic.

  • Destinations: Applications / tool vendors that receive data from the Interactions API on behalf of data owners. Destinations can be CRMs, data warehouses, or other tools that support the utilization of voter and supporter outreach data.

    • Destinations are responsible for maintaining integrations for receiving data from the Interactions API, specifying the data formats that they can accept, and verifying which sources and/or data owners they can receive data from.

This guide details how to get started with the Interactions API for each of these user types - note that organizations can be multiple types!

Video walkthrough

Walk through the Interactions API and follow along with our Getting Started With Testing Guide and our public Postman workspace, or with your API Key in the built-in API Client for the Interactions API.


What’s Next

Navigate to the correct section in the Interactions API Set Up section depending on your user type.