| Method and Path | Description | ||
|---|---|---|---|
| GET | /hipchat/installable | ||
| POST | /hipchat/installable | ||
| DELETE | /hipchat/installable/:oauthId | ||
Your add-on must declare the scopes it requires based on which API endpoints it needs to use, via its descriptor.
| Name | Value | Description |
|---|---|---|
| send_message | send_message | |
| send_notification | send_notification |
Interfaces: None
A request semantic failure reason.
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| description | string | Yes | - |
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| scopes | [hipchat_scope] | Yes | - | An array of scopes that are required to consume the HipChat API.
|
| fromName | string | No | - | The name that messages should be from when sent from the integration itself.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| configurable | hipchat_configuration_page | No | - | Most integrations will need to be configured in order to work correctly. For this purpose, an integration can expose a 'configurable' capability that provides an HTML page to be included as a panel in the configuration dialog.
|
| hipchatApiConsumer | hipchat_api_consumer | No | - | The ability to consume the HipChat API.
|
| installable | hipchat_installable | No | - | The capability of receiving a synchronous installation callback during integration installation.
|
| oauth2Provider | hipchat_oauth2_provider | No | - | The capability of providing and accepting OAuth 2 tokens for authentication.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | The display name of this application.
|
| description | string | Yes | - | A short description of this application.
|
| key | string | Yes | - | The marketplace integration key that uniquely identifies the application, if registered.
|
| apiVersion | string | No | - | The HipChat Connect API version used by this integration. Defaults to 1:1.
|
| capabilities | hipchat_capabilities | No | - | The set of capabilities this application supports.
|
| links | hipchat_links | Yes | - | URLs to retrieve this and related integration information.
|
| vendor | hipchat_vendor | No | - | The vendor that maintains this application.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| allowAccessToRoomAdmins | string | No | - | If the add-on is installed globally, this property can allow the configuration page to be accessed in the room administration pages making it possible to have room specific configuration for the global add-on. This is only valid for globally installed add-ons.
|
| url | string | Yes | - | The URL to embed into a configure dialog via an iframe.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| capabilitiesUrl | string | Yes | - |
|
| oauthId | string | Yes | - |
|
| oauthSecret | string | Yes | - |
|
| groupId | long | Yes | - |
|
| roomId | string | No | - |
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| callbackUrl | string | No | - | The URL to receive a confirmation of an integration installation.
|
| installedUrl | string | No | - | The URL HipChat will redirect to post-installation.
|
| allowGlobal | boolean | No | - | Whether the integration can be installed globally or not.
|
| allowRoom | boolean | No | - | Whether the integration can be installed in a room or not.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| homepage | string | No | - | The URL to human-viewable home page of this integration.
|
| api | string | No | - | The URL to the REST API root.
|
| self | string | Yes | - | The URL to this descriptor.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| tokenUrl | string | No | - | The OAuth 2 token endpoint for retrieving an access token.
|
| authorizationUrl | string | No | - | 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.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | The vendor display name.
|
| url | string | Yes | - | The vendor's home page URL.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | Name of this service.
|
| version | string | Yes | - | Version of this service.
|
| scala_version | string | Yes | - | Version of Scala this service is using.
|
| sbt_version | string | Yes | - | Version of SBT used to build this service.
|
| build_time | date-time-iso8601 | Yes | - | Time the service was built at.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| Type | string | Yes | - | The type of message. For a unsubscribe confirmation, the type is UnsubscribeConfirmation.
|
| MessageId | string | Yes | - | A Universally Unique Identifier, unique for each message published. For a message that Amazon SNS resends during a retry, the message ID of the original message is used.
|
| TopicArn | string | Yes | - | The Amazon Resource Name (ARN) for the topic that this endpoint has been unsubscribed from.
|
| Message | string | Yes | - | A string that describes the message.
|
| Timestamp | string | Yes | - | The time (GMT) when the unsubscribe confirmation was sent.
|
| SignatureVersion | string | Yes | - | Version of the Amazon SNS signature used.
|
| Signature | string | Yes | - | Base64-encoded 'SHA1withRSA' signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
|
| SigningCertURL | string | Yes | - | The URL to the certificate that was used to sign the message.
|
| Token | string | No | - | A value you can use with the ConfirmSubscription action to re-confirm the subscription. Alternatively, you can simply visit the SubscribeURL.
|
| Subject | string | No | - | The Subject parameter specified when the notification was published to the topic. Note that this is an optional parameter. If no Subject was specified, then this name/value pair does not appear in this JSON document.
|
| SubscribeURL | string | No | - | The URL that you must visit in order to re-confirm the subscription. Alternatively, you can instead use the Token with the ConfirmSubscription action to re-confirm the subscription.
|
| UnsubscribeURL | string | No | - | A URL that you can use to unsubscribe the endpoint from this topic. If you visit this URL, Amazon SNS unsubscribes the endpoint and stops sending notifications to this endpoint.
|
