Orbit

Orbit User Guides

Check out these guides and resources for getting the most out of Orbit. Email [email protected] with any questions or feedback. Let's jump right in!

Get Started    API Reference

Set up the Orbit Discourse integration

This guide will walk you through setting up the 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 or new reply, 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.

Initially, Orbit will import that last 12 months of activity. 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, and scroll to and click the Add integration button.

Create an API key on Discourse

You need to be a Discourse Admin to setup a new Discourse integration

  1. In the Discourse Admin interface, go to the API tab and create a new API Key
  1. Fill out the API Key form as follows
    • User Level: Single User;
    • User: your username;
    • Do not select "Global Key (allows all actions)"
    • Scopes: select topics:readtopics:read listsusers:show and users:check emails
  1. 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

  1. In the Discourse Admin interface, go to the API tab and create a new Webhook
  1. 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 events and Post events;
  • 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.

Updated 10 days ago

Set up the Orbit Discourse integration


This guide will walk you through setting up the Discourse integration.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.