Introduction

Topics

Messages

Schemas

Gitter Streaming API 1.0.0

Connection details

URL Scheme Description
https://stream.gitter.im/v1/rooms/{roomId}/{resource}		 https
URL Variables
Name Default value Possible values Description
roomId None Any

Id of the Gitter room.
resource None
  • chatMessages
  • events

The resource to consume.

Security

Type In Name Scheme Format Description
http bearer

Topics

Messages

chatMessage

A message represents an individual chat message sent to a room. They are a sub-resource of a room.

Payload

Name Title Type Format Default Description
id string ID of the message.
text string Original message in plain-text/markdown.
html string HTML formatted message.
sent string date-time ISO formatted date of the message.
fromUser object User that sent the message.
id string Gitter User ID.
username string Gitter/GitHub username.
displayName string Gitter/GitHub user real name.
url string Path to the user on Gitter.
avatarUrl string uri User avatar URI.
avatarUrlSmall string uri User avatar URI (small).
avatarUrlMedium string uri User avatar URI (medium).
v number Version.
gv string Stands for "Gravatar version" and is used for cache busting.
unread boolean Boolean that indicates if the current user has read the message.
readBy number Number of users that have read the message.
urls array (string) List of URLs present in the message.
mentions array (object) List of @Mentions in the message.
screenName string
userId string
userIds array (string)
issues array (object) List of #Issues referenced in the message.
number string
meta array Metadata. This is currently not used for anything.
v number Version.
gv string Stands for "Gravatar version" and is used for cache busting.

Example of payload (generated)

{
  "id": "string",
  "text": "string",
  "html": "string",
  "sent": "2021-03-22T09:59:57Z",
  "fromUser": {
    "id": "string",
    "username": "string",
    "displayName": "string",
    "url": "string",
    "avatarUrl": "http://example.com",
    "avatarUrlSmall": "http://example.com",
    "avatarUrlMedium": "http://example.com",
    "v": 0,
    "gv": "string"
  },
  "unread": true,
  "readBy": 0,
  "urls": [
    "http://example.com"
  ],
  "mentions": [
    {
      "screenName": "string",
      "userId": "string",
      "userIds": [
        "string"
      ]
    }
  ],
  "issues": [
    {
      "number": "string"
    }
  ],
  "meta": [
    null
  ],
  "v": 0,
  "gv": "string"
}

heartbeat

Its purpose is to keep the connection alive.

Payload

Name Title Type Format Default Description
Message Payload string

Example of payload (generated)

"\r\n"

Schemas