API Documentation

rooms/topic

Set a room's topic. Useful for displaying statistics, important links, server status, you name it!

URL

https://api.hipchat.com/v1/rooms/topic

HTTP method(s)

POST

Auth required

Yes, with admin or notification token (details)

Parameters

  • room_id

    Required. ID or name of the room.
  • topic

    Required. The topic body. 250 characters max.
  • from

    Name of the service changing the topic. (default: API)
  • format

    Desired response format: json or xml. (default: json)

Sample JSON request

Request

POST /v1/rooms/topic?format=json&auth_token=token HTTP/1.1 Host: api.hipchat.com Content-Type: application/x-www-form-urlencoded Content-Length: 102 room_id=10&topic=Total+customers%3A+37%2C984

Response

HTTP/1.1 200 OK Content-Type: application/json { "status": "ok" }

Sample XML request

Request

POST /v1/rooms/topic?format=xml&auth_token=token HTTP/1.1 Host: api.hipchat.com Content-Type: application/x-www-form-urlencoded Content-Length: 102 room_id=10&topic=Total+customers%3A+37%2C984

Response

HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <status>ok</status>

Response fields

  • status — Delivery status. The only current value is "ok".

Notes

  • There may be a slight delay before the topic change appears in the room.
  • HTML is not currently allowed, but we'd like to allow it in the future.