Hipchat Webhooks global integration

Hello, i have a question about custom webhooks. According to documentation


Webhooks can be registered by a user or integration to receive a notification of an event. They can currently only be registered against a specific room via the the REST API.

If i get it, it means that i can create global(All rooms) webhooks through API. But when i check that api out, i see

Create webhook


I must set up room id, otherwise it answers with 400 and asks me to specify it.

Please, can you show me the way in which i can make my integration global?

3 answers

1 vote

Hi Sergey,

If you declare a webhook in your capabilities descriptor, and your add-on is installed globally, the webhook will automatically be installed in every room. For example:

"webhook": {
  "url": "https://addon.example.com/echo",
  "pattern": "^/[eE][cC][hH][oO]",
  "event": "room_message",
  "authentication": "jwt",
  "name": "Echo"

You cannot yet register a global webhook by calling the REST API.




1 vote

Global webhooks need to be declared in the capabilities descriptor of your integration. They will be setup by HipChat when the integration is installed. Add one or more webhooks into the "webhook" element of the capabilities descriptor.




@Tanguy Crusson, @Conor MacNeill thank you guys! Does it mean that i can't install global webhook without Integraton? I have to provide, at least, http://my-site.com/descriptor.json with format just like you've written before?

That is correct: you cannot add a webhook just using a token, you have to provide a descriptor. It's all explained here: https://ecosystem.atlassian.net/wiki/display/HIPDEV/Building+an+add-on

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Nov 14, 2018 in Hipchat Cloud

Hipchat Cloud and Stride have reached End of Life (updated)

All good things come to an end - thanks to all our customers and partners who have been along the Hipchat and Stride journey with us.  As of Feb 15th 2019, Hipchat Cloud and Stride have reached ...

32,691 views 7 7
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you