API Reference version 2

Get capabilities

GET/v2/capabilities

Gets the capabilities descriptor for HipChat

Authentication not required.
200 application/json
Type Property Description Required?
object vendor

The vendor that maintains this application

string url

The vendor's home page URL

Required
string name

The vendor display name

Required
string name

The display name of this application

Required
object links

URLs to retrieve this and related integration information

Required
string self

The URL to this descriptor.

Required
string api

The URL to the REST API root.

Required
string homepage

The URL to human-viewable home page of this integration

object capabilities

The set of capabilities this application supports.

object oauth2Provider

The capability of providing and accepting OAuth 2 tokens for authentication

string tokenUrl

The OAuth 2 token endpoint for retrieving an access token

string authorizationUrl

The OAuth 2 endpoint to direct browsers to in order to receive an authorization code that can be later exchanged using the token URL for an access token

object hipchatApiProvider

The ability to provide the HipChat API

string url

The base URL for the API

Required
object availableScopes

The scopes that this API supports.

Required
string key

The key that uniquely identifies the application

Required
string description

A short description of this application

Required