🚧

Activity Types Endpoint Deprecation Notice

Beginning on July 5, 2021, the activity types endpoint is slated to be removed. A new activity types endpoint scoped to individual workspaces will be introduced to take its place.

If you have any questions or concerns please contact [email protected] or connect with us on Discord.

Every activity has exactly one activity type. Think of the activity type as a schema for each activity that controls how it is displayed and other metadata about it. Orbit supports a handful of types today that you can see by calling the /activity_types endpoint.

Activity Type properties

{
  "id": "12",
  "type": "activity_type",
  "attributes": {
    "name": "Opened an issue",
    "short_name": "Issue opened",
    "key": "issues:opened",
    "category":  "github",
    "weight":    "1.0"
  }
}

Property

Type

Description

name

string

The full name of the activity type.

short_name

string

A short name describing the activity type, for use in charts, for example.

key

string

The key that will be used by APIs to refer to this activity type. Must be unique.

category

string

The category of the activity type, e.g. github, twitter,
discourse

weight

float

The weight score of the activity.