Set Up for Data Owners

Instructions for how to get started with the Interactions API as a Data Owner

1. Confirm that your Sources and Destinations are set up with the Interactions API

For the Interactions API to successfully move your data between your Sources and Destinations, they must set up and maintain integrations with the Interactions API. To receive a current list of supported integrations and request additional integrations, reach out to [email protected].

2. Create API Keys

To get started using the Interactions API, you will need to create an API Key.

An API Key tells the Interactions API who you are, what Source you are sending data from, and what Destinations your data should flow to. You can have multiple API Keys for a specific Source, but you can only have one Source for each API Key.

Here's an example of how you can have multiple API Keys for one Source:

  • API Key A: Texting tool -> Data warehouse
  • API Key B: Texting tool -> Data warehouse + CRM
  • API Key C: Texting tool -> CRM

When your Texting tool uses API Key A, your data will only flow to your data warehouse. If your Texting tool uses API Key B, your data will automatically be sent to both your data warehouse and your CRM.

To create an API Key, log in to the Console and navigate to Create & Manage Keys under the Interactions API tile. You will name your API key, select the Source and Destinations, and optionally set an expiration date. Expiration dates cannot be changed after the key is created. You can only view your API Key one time and it should be stored in a secure location.

Once you have received your API Keys, you are responsible for sharing them with your Sources unless otherwise specified. For information on how to share API Keys with your Sources, please consult your Sources directly.

A detailed guide to API Key creation can be found here.

Managing API Keys

API Keys are secrets that should be securely stored. If your API Keys are compromised, unauthorized actors will have access to send data on your behalf to your systems.

You can edit a key's name or destinations, or delete it, yourself from Create & Manage Keys -> Actions. Expiration dates cannot be changed after creation. Reach out to [email protected] if you need help.


What’s Next

Did this page help you?