Provision an API Key

An API Key does a few core things. It provides you with an authentication key, stores some metadata about who owns the data, and its source (e.g. a committee and an app, respectively) and it determines which destinations those Interactions will go to.

API keys can now be provisioned with a valid organizational account in the DDx API Console. Review the Detailed Guide: API Key Creation to provision a key!

🤔
Do you need an Organizational Workspace? Click here to learn more about DDx API Workspaces and permissions structure!

Use Sandbox mode or subscribe to your own events

As a user trying out the Interactions API, you have two options for testing.

For basic testing of authentication and request formatting: You can run in sandbox mode, where interactions are received and acknowledged but not delivered to any configured Destinations.
For end-to-end testing of the API as both a source and destination You can set up your own Data Destination, and set up an API key that sends your events to yourself. You can then follow the Data Destination guide to listen to your own events.

Send your first requests

We have a Postman collection here https://www.postman.com/mig444-2570/mig-api-samples/overview or Readme URL instructions

Common questions

How is the outbound pub/sub message formatted?

See Data Format in Pub/Sub for the model of messages sent via Pub/Sub to data destinations.

How can I change a destination or toggle sandbox mode?

This can be done via via self-service in the DDX API Console under the 'Create & Manage Keys' option on the Interactions API tile. Select 'Actions' -> 'Edit' on the Interactions API key for which you would like to update the Destination.

How can I rotate a key?

This can be done via via self-service in the DDX API Console by creating a new Key, provisioning it to the Source it's meant for, and then delete the old key by going to Create & Manage Keys -> Interactions API Keys -> select 'Actions' -> select 'Delete' -> type 'DELETE' to confirm. Review these steps under Detailed Guide: API Key Creation!

What observability do I have into my interactions?

The best way to see your own interactions is to either:

1. Set up your own test destination, and send your interactions to it

When setting up as a data source, you can also set up a data destination and configure your API key to send interactions to that destination. This requires additional work but gives you absolute transparency into how your data is being streamed to destinations.

2. Work with a partner org's test destination to validate they are seeing your test traffic

Major partners are already set up as destinations in DDx API, and generally have test destinations that can be used to validate throughput of interactions traffic on an ad-hoc basis. Contact [email protected] or your data destination to get the process started.

Destinations will be available to configure self-service through the DDX API console in Q1 of 2026.

How will I know about new versions of the API?

You can view new versions on our Changelog. You can also subscribe to an RSS version of the Changelog.

DDX also sends out email announcements ahead of major updates. You can subscribe to our email list here.

How do I test new versions of the API?

Large API updates will be announced as described here.

New versions of the API will be accessible by changing the {version} segment of the endpoint URL (see the /interactions reference documentation). The URL follows the format of /v{version}/{endpoint}, so a current version, e.g./v1/interactions could coexist with a later version with breaking changes, e.g./v2/interactions.

For testing new API versions, you can configure an API key in sandbox mode and configured with yourself as a destination ). You can use this test key to validate any updates to the behavior of your integrations with a new API version.