📙

Orbit API

Documentation

‣
Getting Started
📙
What is Orbit?
📙
Understanding the Orbit Model
📙
Orbit Glossary
‣
Workspaces
📙
Create an Orbit workspace
📙
Invite a teammate
📙
Enable SSO (Single Sign-On)
📙
Demo mode
‣
Programs
📙
Intro to Programs
📙
Create a Program
📙
Import a CSV of Applications
📙
Collect applications via a Web Form
📙
Connect third-party forms to receive new submissions to Program
📙
Review and Manage Applications
📙
Onboard Program Members
📙
Collect Contributions from your Members
📙
Manage Program Settings
‣
Members
📙
Intro to members
📙
View an individual member
📙
Preview a member
📙
Explore members via the members tab
📙
Add a member
📙
Edit a member
📙
Merge duplicate members
📙
Delete a member
📙
Add a tag to a member
📙
Add, edit, and delete notes on a member
📙
Add an activity to a member
📙
Mark profile as a teammate
📙
Send member to a webhook
‣
Activities
📙
Create an activity type
📙
Intro to activities
‣
Organizations
📙
Intro to organizations
📙
View an individual organization
📙
Identify an organization as a customer
‣
Reports
📙
Create a custom dashboard
📙
Drill down into reports
📙
Quickly build an activities chart
📙
Understanding sentiment analysis
‣
Automations
📙
Automations [deprecated]
📙
Webhooks
📙
Set up a manual webhook
📙
Workflows
📙
Slack notifications
📙
Set up an automated webhook
‣
Productivity
📙
Member lists
📙
Tags
📙
Manage tags
📙
Create a saved view
📙
Share a saved view
📙
CSV import for members and activities
📙
Using filters on the members tab
📙
Using filters on the activities and reports tabs
📙
Keyboard shortcuts
📙
Search
‣
Integrations
📙
All possible data integrations with Orbit
📙
DEV integration
📙
Discord integration
📙
Discourse integration
📙
GitHub integration
📙
HubSpot integration
📙
inSided integration
📙
LinkedIn integration
📙
Reddit integration
📙
Salesforce integration
📙
Slack integration
📙
Stack Overflow integration
📙
Twitter integration
📙
Twitter keywords integration
📙
YouTube integration
📙
Zapier integration
📙
Twitter DMs integration
‣
Tools
📙
Orbit API
📙
Export workspace data
📙
Delete workspace data
📙
API tokens
📙
Community Search
📙
Orbit Browser Extension
📙
Embeds
📙
Slack App
📙
Stripe Dashboard application
‣
FAQ
📙
How are historic Discord imports handled after initial set up?
📙
How can I filter members to only see those with notes added?
📙
How does member enrichment work?
📙
Is test data available to try in Orbit?
📙
What activities are tracked by each integration?
📙
What can I do if I imported a CSV with incorrect column headers?
📙
What's the difference between Activities and Tags?
📙
Why am I no longer designated as a teammate?
📙
Why are there differences between member counts on Orbit and Discord?
📙
Why can't I see the Plug & Play integrations?
📙
Why is my CSV file not importing?
📙
Will uninstalling an integration remove activities from Orbit?
📙
How is the new members table different from the old members table?

Orbit API

The Orbit API allows you to work with your Orbit workspaces from the comfort of your own programs, apps, and tools. What can you do with the API? A lot, including most of what is possible in the Orbit application itself:

  • Add new members by GitHub handle, Twitter handle, Discourse username, email address, or even custom sources like your own product
  • Create activities - the magical, atomic units of member participation and contribution
  • Add content, notes, and tags to members
  • Fetch members by their Orbit id, GitHub handle, email, or other identities
  • Fetch members and activities using different filters and sorts
  • Download your workspace data in JSON or CSV format

API Documentation Link

API Objects

The API allow you to work with many different types of Orbit data. See the API documentation to learn more.

  • Users
  • Activities
  • Activity Types
  • Members
  • Notes
  • Organizations
  • Reports
  • Destinations
  • Workspaces
DiscordXGitHubLinkedIn