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 properties

{
  "id": "3354926",
  "type": "activity",
  "attributes": {
    "action": "created",
    "created_at": "2020-10-11T18:52:48.575Z",
    "key": "dzello/reveal-hugo#95-706750880",
    "occurred_at": "2020-10-11T18:52:47.000Z",
    "updated_at": "2020-10-11T18:52:48.575Z",
    "type": "IssueCommentActivity",
    "g_number": 95,
    "g_html_url": "https://github.com/dzello/reveal-hugo/issues/95#issuecomment-706750880",
    "g_created_at": "2020-10-11T18:52:47Z",
    "g_id": 706750880,
    "g_body": "You're welcome. I believe you can set `history` to false in the Reveal.js settings to accomplish that.\r\n\r\nTo do that with reveal-hugo, add the configuration in config.toml:\r\n\r\n```toml\r\n[reveal_hugo]\r\nhistory = false\r\n```\r\n\r\nLet me know if this works for you.",
    "is_pull_request": false
  },
  "relationships": {
    "activity_type": {
      "data": {
        "id": "9",
        "type": "activity_type"
      }
    },
    "member": {
      "data": {
        "id": "48986",
        "type": "member"
      }
    },
    "repository": {
      "data": {
        "id": "2709",
        "type": "repository"
      }
    }
  }
}

Property

Type

Description

action

string

The type of action the user did for that activity, e.g. created, merged, opened.

created_at

datetime

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

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.

type

sting

The type of activity, e.g. IssueCommentActivity, TweetActivity.

occurred_at

datetime

The date and time at which the activity occurred.

updated_at

string

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

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