Activities are instances of community participation and contribution, such as GitHub issues, pull requests, Discourse posts, mentions on Twitter, and more. Orbit integrations come with built in activities but you can also add your own.

Activity attributes

{
  "id": "3354926",
  "type": "activity",
  "attributes": {
    "key": "dzello/reveal-hugo#95-706750880",
    "properties": {
      "github_organization": "dzello",
      "github_repository": "dzello/reveal-hugo",
      "github_issue": "dzello/reveal-hugo/#95",
    },
    "created_at": "2020-10-11T18:52:48.575Z",
    "updated_at": "2020-10-11T18:52:48.575Z",
    "occurred_at": "2020-10-11T18:52:47.000Z",
  },
  "relationships": {
    "activity_type": {
      "data": {
        "id": "9",
        "type": "activity_type"
      }
    },
    "member": {
      "data": {
        "id": "48986",
        "type": "member"
      }
    },
    "repository": {
      "data": {
        "id": "2709",
        "type": "repository"
      }
    }
  }
}

Property

Type

Description

key

string

A unique identitier for the activity that makes sure duplicates of it are not recorded. Optional but recommended if your integration may resend data multiple times. A strong key choice might be the id or timestamp of an event registration along with the event name, e.g. "july-conference-registration:123456". If Orbit receives a POST to create an activity with that key more than once for the same member, it will only create one.

properties

object

Key-value pairs of contextual metadata associated with an activity.

created_at

datetime

The date and time at which the activity was created in Orbit.

updated_at

datetime

The date and time at which the activity was last updated in Orbit.

occurred_at

datetime

The date and time at which the activity occurred.

Other attributes might be attached to the activity object depending on its type.