naftiko: 1.0.0-alpha2
info:
  label: HipChat REST API v2 — Messages & Notifications
  description: HipChat Messages and room notifications (historical; sunset 2019-02-15). Subject to a
    flood-control limit of 30 requests/minute per room and 500/5min overall.
  tags: [HipChat, Messages, Notifications, Sunset]
  created: '2026-05-23'
  modified: '2026-05-23'
  status: sunset
  sunsetDate: '2019-02-15'
binds:
- namespace: env
  keys:
    HIPCHAT_API_TOKEN: HIPCHAT_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: hipchat-messages
    baseUri: https://api.hipchat.com/v2
    description: HipChat message-send and history operations.
    resources:
    - name: room-notification
      path: /room/{id_or_name}/notification
      operations:
      - {name: sendroomnotification, method: POST, description: HipChat Send Room Notification}
    - name: room-message
      path: /room/{id_or_name}/message
      operations:
      - {name: sendroommessage, method: POST, description: HipChat Send Room Message}
    - name: room-history
      path: /room/{id_or_name}/history
      operations:
      - name: getroomhistory
        method: GET
        description: HipChat View Room History
        outputRawFormat: json
        outputParameters: [{name: result, type: object, value: $.}]
        inputParameters:
        - {name: date, in: query, type: string}
        - {name: timezone, in: query, type: string}
        - {name: start-index, in: query, type: integer}
        - {name: max-results, in: query, type: integer}
        - {name: reverse, in: query, type: boolean}
    - name: room-history-latest
      path: /room/{id_or_name}/history/latest
      operations:
      - {name: getlatestroomhistory, method: GET, description: HipChat View Recent Room History}
    authentication:
      type: bearer
      token: '{{env.HIPCHAT_API_TOKEN}}'
  exposes:
  - type: rest
    namespace: hipchat-messages-rest
    port: 8080
    description: REST adapter for HipChat Messages.
    resources:
    - path: /v1/rooms/{id_or_name}/notification
      name: room-notification
      operations:
      - {method: POST, name: sendroomnotification, call: hipchat-messages.sendroomnotification}
    - path: /v1/rooms/{id_or_name}/message
      name: room-message
      operations:
      - {method: POST, name: sendroommessage, call: hipchat-messages.sendroommessage}
    - path: /v1/rooms/{id_or_name}/history
      name: room-history
      operations:
      - {method: GET, name: getroomhistory, call: hipchat-messages.getroomhistory}
    - path: /v1/rooms/{id_or_name}/history/latest
      name: room-history-latest
      operations:
      - {method: GET, name: getlatestroomhistory, call: hipchat-messages.getlatestroomhistory}