Documentation
Discourse integration
The Orbit Discourse integration allows you to connect your Discourse instance to Orbit. The integration will automatically create an Activity for any new topic, new reply, or user account creation, and it will save that Activity to an existing member's profile. If the post is from a person not already associated with your workspace, Orbit will create a new member.
The table below summarizes what is included in this integration:
Activities | - New topic created
- New post created
- New member account created |
Historical Import | - Up to 100,000 posts or 365 days of posts retrospectively from the date of connecting the integration to Orbit |
Does not track or import | - Post likes
- Badge grants |
🚧 The Orbit Discourse integration only works with public Discourse hosts. Orbit will not be able to pull data from private Discourse hosts that require a user login to view any content.
Initially, Orbit will import the last 12 months of activity with a limit of up to 100,000. If you'd like more history, just let us know.
Connect your Discourse account
If you're setting up a new workspace, you'll see the Connect Discourse button during setup.
If you're adding Discourse to an existing workspace, navigate to your workspace settings page, then to the Integrations tab and click the Discourse logo in the Plug & Play Integrations section.
Create an API key on Discourse
You need to be a Discourse Admin to setup a new Discourse integration
- In the Discourse Admin interface, go to the API tab and create a new API Key
- Fill out the API Key form as follows
- User Level: Single User;
- User: your username. If you use any other username, make sure it’s an admin or a moderator. Otherwise we won’t be able to retrieve your members’ emails;
- Do not select "Global Key (allows all actions)"
- Scopes: select topics:read, topics:read lists, users:show and users:check emails
📘 You can opt-out of retrieving and using the members' email addresses available in Discourse. This will prevent us from populating your members’ emails, and linking their Discourse identities to any other we might have available in your community already (e.g. their GitHub or Twitter profiles). To do so, please send us an email at [email protected] with the name of the workspace you wish to opt-out and we will give you further instructions to proceed with the installation.
- Save the form and copy the API key
If you have a Discourse group for your teammates, the integration can automatically mark its members as teammates. You can get its ID by visiting the group page and appending .json to the URL.
Configure the new Discourse integration in Orbit
After setting up your API key on Discourse, complete the Orbit form presented during the setup flow:
Connect Webhooks
- In the Discourse Admin interface, go to the API tab and create a new Webhook
- Fill out the Webhook form as follows
- Payload URL and Secret Key - Orbit will provide this during the setup process
- Content Type: Application/json;
- Individual events: Topic Event, Post Event and User Event;
- Triggered Categories and Triggered Groups: leave empty;
- Check TLS certificate of payload URL: Checked
- Active: Checked
Finally, save the form.
Due to Discourse rate limits, the import will take from several minutes to several hours.
Reporting
Discourse activity will now appear alongside other integrations in your reports.
