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

Adding activities

This guide will walk you through adding custom activities to a member in the Orbit web app.

Overview

There are several ways to automatically add activities to members, including through the GitHub integration, Twitter integration, and the API.

But sometimes you just want to add a single one-off activity to a member profile, like when you have a zoom or coffee meeting, they speak at an event on your behalf, or otherwise contribute in a meaningful way.

In those cases, navigate to their profile page ad click Add an activity:

The Add an activity button is available on the member profile page.

Clicking that link will open a dialogue for entering the event:

Activity fields

A screenshot of an activity with the 4 fields highlighted.

Refer to the image above to see where these fields appear in the timeline items:

  1. Title (required)
  2. Description
  3. Link Text
  4. Link URL
  • Type: this optional hidden field will allow you to group and report on activity types, like events, meetups, pull requests, tweets, etc.
  • Key: this optional hidden field is used to avoid duplication of activities.

Further reading

To learn more about specific types of activities added by Orbit's integrations, as well as the idea of activity weights, please read this changelog entry.

Updated 5 months ago

Adding activities


This guide will walk you through adding custom activities to a member in the Orbit web app.

Suggested Edits are limited on API Reference Pages

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