Use the REST API to get information about rooms and post messages.

HTTP Methods

We try to uphold RESTful principles in the API. Listing, showing and other non-state-altering actions are done with GET, creating with POST, PUT for updating and deleting with DELETE.

URL Breakdown
  • https: The Gitter API is served over secure HTTP only.
  • v1: API version.
  • rooms: The resource which is being requested.
  • roomId: The ID of the Room.
  • chatMessages: The sub-resource, a resource which is accessed in the scope of the parent resource. For example, all the messages in a room. In some cases there may be multiple sub-resources.

Structure of an API request

Example of posting a message:

POST /v1/rooms/:roomId/chatMessages


Content-Type must be defined in the header of requests that contain data.

Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}


  "text":"Happy Hacking!"


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
  "text":"Happy Hacking!",
  "html":"Happy Hacking!",
    "displayName":"Mauro Pompilio",