Skip to main content
API keys grant access to your Discourse instance. Keep them secure and never share them publicly.

​
Find Your Discourse Domain

Your Discourse domain is the base URL of your Discourse instance (e.g., community.example.com).

1

Identify your domain

Log in to your Discourse instance and copy the domain directly from your browser’s address bar (e.g., stackone-sandbox-pro.discourse.group). Do not include https:// or a trailing slash.

​
Generate an API Key

Create an API key from the Discourse admin panel to authenticate API requests.

1

Navigate to API Keys

Log in as an admin, click Admin in the left sidebar, then go to Advanced > API keys (or navigate to /admin/api/keys).

2

Create a new key

Click Add API key.

  • Set a Description (e.g., “StackOne Integration”).
  • Set User Level to All Users for global access, or select a specific user.
  • Set Scope to Global to allow full access to all API endpoints.
  • Click Save to generate the key.
3

Copy the API Key

Copy the generated API key and store it securely. It will not be shown again.

​
Determine the API Username

The Api-Username header identifies which user the API requests are made on behalf of.

1

Choose a username

Use your admin username — this is displayed in the welcome message on your Discourse homepage (e.g., john_admin). You can also use system for system-level admin access. The user must have permission for the actions you intend to perform.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Domain
  • API Key
  • API Username
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.