Create a Discourse API key

Common Room’s Discourse integration requires an API key to import Contacts and Activity.

Setup

1. Open the Discourse API settings from the Admin menu.
2. Click New API key, and enter in the following information.
   1. Description: Common Room
   2. User Level: Single user
   3. User: your username (must have admin privileges)
   4. Scope: Global
      

      You can use either a global or a non-global API key with our integration. We recommend using a global key, which works with all Discourse setups and allows imports to run the fastest, especially for larger communities.

3. Copy your API key and click continue

How to create a non-global key

A non-global key works with most Discourse setups and requires reduced permissions, but cannot import data as quickly as with a global key. You can use a non-global key with reduced permissions with Common Room as long as your Discourse instance does not have the login required setting enabled.

To use a non-global key:

1. Verify that login required is disabled
   

   

2. Follow the steps above to create an API key, but leave Global Key unchecked (or in some Discourse versions, select Granular in the Scope dropdown) and instead select the following scopes:
   1. Topics ⇒ read
   2. Topics ⇒ read lists
   3. Users ⇒ show
   4. Users ⇒ check emails