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

Getting started

This guide will walk you through creating an Orbit account, setting up a workspace, adding community members, and inviting teammates.

Creating a new Orbit account

You can create an account with an email address or a GitHub account.

Signing up with GitHub allows Orbit to automatically import activity and members from approved repos.

Setting up a new Orbit workspace

Once you've created your account, you'll be asked to create a workspace.

To automatically import members and activities, a workspace connects to one or more Twitter accounts, GitHub users or organizations, and to any number of services via API.

The workspace is the container for your community. To collaborate, you will invite teammates to the workspace.

A screenshot of the Create a workspace form, showing a text input for the workspace name and a “Create workspace” button

📘

If you have personal repos you'd like to track with Orbit, just create a separate workspace.

If you have personal repos you'd like to track with Orbit, just create a separate workspace.

Key concepts: Members and Activities

Two major concepts in Orbit are Members and Activities.

Member is a community member who is added to Orbit: manually, via an integration, or via API. Each member has a profile page where you can see lots of data about that member as well as a timeline of activities they’ve done, content they’ve created, and more.

Activities are things a member does, like replying to a question in your forum, commenting on a repository on GitHub, submitting a form, attending a webinar, or even meeting in person—any verb that’s a meaningful action you’d like to keep track of.

Once you've integrated a few data sources for generating members and activities, you'll start to have a single view of your whole community.

Adding community members to your new workspace

There are several ways to add your community members to Orbit. You can use one or multiple.

Setup the Orbit Discourse integration

The Orbit Discourse 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.

How to setup the Orbit Discourse integration

Setup the Orbit GitHub integration

The Orbit GitHub integration will automatically ingest contributors and activities from the repos you provide access to. We'll create a profile for every contributor, a global and personal timeline for all activities, and generate an automatic report.

How to setup the Orbit GitHub integration

Setup the Orbit Twitter integration

The Orbit Twitter integration allows you to connect one or more Twitter accounts to your workspaces.

The integration will automatically create an Activity for any mention of connected accounts, and it will save that Activity to an existing member's profile. If the tweet is from a person not already associated with your workspace, Orbit will create a new member.

It will also generate a Member for each one of your Twitter followers.

How to setup the Orbit Twitter integration

Add Members and Activities with the Orbit API

The Orbit API lets you create and edit community members, and to create activities for members from any data source.

Orbit API Documentation

Add Members and Activities with the Orbit API + Zapier app

Use our Zapier app (beta) to connect Orbit to your favorite services, including event platforms, form builders, product analytics, and more.

Orbit Zapier Zap Examples

Add Members with the Orbit GitHub extension for Chrome

View a member's GitHub activity, and new members to your workspace directly from a PR or Issue using our Chrome extension.

How to install the Orbit Chrome extension for GitHub

Add members to your workspace manually

To add members on an ad hoc basis, navigate to the Members page and click the New button.

The New button from the Members page is outlined.

Simply add an email address, GitHub handle, or Twitter username to get started.

Orbit will automatically ingest metada, like avatar and bio, for the user based on the source you provide.

Add members to your workspace via CSV

To import several members to your workspace at once, add first all the members to a CSV file. Navigate to the Workspace Settings page, click the Import tab, then Import CSV.

The Import CSV button from the Import page is outlined.

The expected CSV format is as follows:

NOTE: Be sure to quote column data that contains a comma, such as tags.

At least one of the following is required

ColumnTypeDescription
nameTextThe full name for the member
emailTextThe email address for the member
githubTextThe Github username for the member
twitterTextThe Twitter username for the member
linkedinTextThe LinkedIn username for the member
discordTextThe Discord username for the member

The following columns are optional

ColumnTypeDescription
bioTextThe member's bio
birthdayTextThe member's birthday
companyTextThe member's company
titleTextThe member's title at the company
locationTextThe member's location
pronounsTextThe member's pronouns
shipping_addressTextThe member's shipping address
tshirtTextThe member's T-Shirt size
urlTextThe member's website
avatar_urlTextLink to the member's avatar
teammateBooleanWhether the member is a teammate or not
tagsArray (Text)Tags to associate with the member (e.g. "tag1,tag2,tag3")

📘

Need inspiration? Here's how we use Orbit at Orbit

Inviting others to your workspace

To add others to your workspace, navigate to Settings, find the Add a collaborator section, and enter the email address of the person you'd like to invite. They'll receive an email with instructions.

The Add a collaborator form, with an email address field and a submit button

You can see outstanding invitations in the Team section, and revoke or resend invites as needed.

If you're a workspace owner, you can also mange the permissions of others in the workspace.

The Team table allows you to see and manage permissions within your Orbit team.

📘

Need inspiration? Here's how we use Orbit at Orbit

Updated about a month ago


Getting started


This guide will walk you through creating an Orbit account, setting up a workspace, adding community members, and inviting teammates.

Suggested Edits are limited on API Reference Pages

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