Interactions API Setup

📘

Looking to hit the ground running? Check out the Quick Start for Data Sources

The first step is to identify which type of user you are, as this will determine your setup steps.

What kind of user am I?

• You are a Data Owner if:
  You are a campaign, committee, or other entity that is using data to organize or canvass, and you own the outreach data, then you are a data owner. Set Up for Data Owners

• You are a Data Source if:
  You are a software tool (like a texting, email, or canvassing application) that sends data to the Interactions API on behalf of data owners. Set Up for Sources

• You are a Data Destination if:
  You are a software tool (like a CRM, data warehouse, or analytics platform) that receives interactions data from the Interactions API. Set Up for Destinations

See also (especially for more sophisticated testing scenarios): FAQ: What kind of user am I?

Still not sure? Look at some example use cases in our FAQ

Assumptions

This guide is targeted at software developers or those with some experience interfacing with APIs and Cloud Infrastructure. It is language-agnostic and does not require specific language knowledge, but does involve some Google Cloud concepts.

This guide will primarily focus on data sources and data destinations.

Data owners are key partners but they do not interface directly with the Interactions API, but rather do so through a source or destination. As a result, owners do not require setup beyond requesting and sharing an API Key with their partner data sources.

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.

Demo of the Interactions API

You can view the demo video at: https://www.loom.com/embed/16e687de0f384902897e63b5139671f8