API / Zapier integration overview

Last updated Jul 1st, 2024

Overview

Common Room offers an API you can use to programmatically interact with Common Room data.

Additionally, we offer a native Zapier integration which you can use to push data into Common Room without any code. This is a great option if you don't have a developer available who can build a native API integration.

Create an API token

In order to work with our API, you will need to first create an API token. Tokens can be used with the Common Room REST API or with integration tools like Zapier.

  1. Open SettingsAPI tokens.
  2. Click New Token.
  3. Copy the API token and store it in a safe place. For security reasons ,we won't show you this token again.

Create an API Signal

When using the API or Zapier integration to write data into Common Room, we recommend that you set up an API signal, which will set up a custom destination signal for all your Activities and Contacts.

  1. Open Settings → Signals in Common Room and select API from the list of signals.
  2. Ensure you have an API token available for use. If you need a new token, click the button to generate a new one.
  3. Name your signal something memorable to identify the signal.
  4. Copy the destinationSourceID to use in your API integration. Unlike your API key, you can always reference this code
  5. Copy the provided destinationSourceId code to use with the API or Zapier integration.

FAQ

Is there a way to test how Activity will appear in Common Room?

We recommend creating a sandbox API signal for testing, and then disconnecting the signal when you’re finished.

Didn't find your answer?Get in touch· Visit ourhelp center