Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HipChat Webhooks API

Event-driven webhook delivery from HipChat rooms. Webhooks could be registered via the REST API or declared in an add-on descriptor. Each delivery included a JWT-signed signed_request query parameter that the receiving service was expected to verify. The room_message event was the primary integration pattern, with additional events covering room enter, exit, topic change, archive, notification, and file upload. The webhook surface was retired with the rest of HipChat on February 15, 2019.

This event API exposes 10 operations across 10 channels, and defines 13 schemas. It is described by AsyncAPI 2.6.0, at version 2.0.

The API connects through a single server, hipchat-cloud (https).

10 operations 10 channels 13 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
2.0
Server
hipchat-cloud (https)
Resource Areas
1

Channels & Operations 10

Across 10 channels, the API surfaces 10 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 10
SUB
/webhook/room_message
Message Posted To Room
onRoomMessage body
SUB
/webhook/room_notification
Notification Sent To Room
onRoomNotification body
SUB
/webhook/room_enter
User Entered Room
onRoomEnter body
SUB
/webhook/room_exit
User Exited Room
onRoomExit body
SUB
/webhook/room_topic_change
Room Topic Changed
onRoomTopicChange body
SUB
/webhook/room_archived
Room Archived
onRoomArchived body
SUB
/webhook/room_unarchived
Room Unarchived
onRoomUnarchived body
SUB
/webhook/room_deleted
Room Deleted
onRoomDeleted body
SUB
/webhook/room_created
Room Created
onRoomCreated body
SUB
/webhook/room_file_upload
File Uploaded To Room
onRoomFileUpload body

Messages & Schemas 13

The contract defines 13 schemas that model the data carried by its messages. The most detailed is BaseEnvelope (4 properties). Each schema is shown below with its type and property counts.

RoomMessageEvent
message
Webhook delivery for a message posted to a room.
RoomNotificationEvent
message
RoomMembershipEvent
message
RoomTopicChangeEvent
message
RoomLifecycleEvent
message
RoomFileUploadEvent
message
BaseEnvelope
object
4 properties
RoomMessageEnvelope
object
RoomNotificationEnvelope
object
RoomMembershipEnvelope
object
RoomTopicChangeEnvelope
object
RoomLifecycleEnvelope
object
RoomFileUploadEnvelope
object

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

hipchat-webhooks-asyncapi.yml Raw ↑