Does Hip Chat server provide API for retrieving unread messages count?

[Artem Baranovskii]

We're planning to install HipChat on our local server and integrate with our corporate web application. What we're trying to understand is either we able to show unread messages from HipChat count in our menu or not?

At first glance, your API looks comprehensive but we couldn't find any mentions on related to "unread", "notifications" or so. What we're trying to archeive is the following workflow:

1. User opens up our web application.
2. On top right side menu he can see a bell with unread messages count in hipchat.
3. Clicks on a bell and opens up hipchat.

Is there related API on this case?

[AhmadDanial · Accepted solution]

Hello, Артем.

While we do not have an API that pulls the information about unread messages for rooms & 1-1 conversation listed in the official API V2 documentation, the unread message counter is a feature that was introduced in HipChat 2.2.8 as mentioned in the public suggestion here:

• HCPUB-2603: HipChat Server - Sync messages across clients so I can catch up on conversation that's happened while I was away / offline / idle

In this case, can you please define what web application you are actually referring to? Are you actually referring to the web interface of HipChat itself or a web application that is developed from your end?

Additionally, are you referring to the unread icon similar to what we have on Mac dock / windows taskbar?

[Artem Baranovskii]

Hello, Ahmad.
Let me explain our architecture in more detail.

We're developing a web application that is being resided in our corporate network. We need to add chat functionality and have chosen your HipChat Server as communication service.

We're going run this server in separate instance with its own url (e.g: hipchat.company.local) and reside the link to this service in topmenu of our main application (e.g: company.local) Are you actually referring to the web interface of HipChat itself - yes

As a result, we need to display the unread message counter near by the link to hipchat service as in your screenshot you've put together.

[AhmadDanial]

Hi, Artem.

I had a discussion internally and as of now, we do not have an API V2 that is capable of pulling the information that you require. Would you like to raise a Suggestion to address this need to the dev team to see if it something that they might consider in the future in the public tracker - https://jira.atlassian.com ?

I can also do that on your behalf if you prefer. Let me know which one works for you best.

[Artem Baranovskii]

Hi, Ahmad.

Thank you for the reply. We're currently gathering information about several chat applications like HipChat to propose the best solution to our stakeholders.

It would be great if you could raise a Suggestion for this feature.

Thank you in advance.

[AhmadDanial]

Hi, Artem.

You are welcome. I went ahead and created the Suggestion below to address this to the development team:

• HCPUB-21641 HipChat API V2: GET Unread Message Counter API for Rooms & 1-1 Conversation

I encourage you to visit the suggestion page linked above and click the Vote and Watch links near the top right to show support for the feature. By doing this, it will ensure you are proactively informed of progress and updates going forward.

Feel free to share your feedback or additional suggestion by leaving a comment on the ticket as this helps us prioritize & understand the use case of the feature request. Hope it helps!

[Artem Baranovskii]

Hi, Ahmad!

Thank you again!

[AhmadDanial]

Hi, Artem.

Any time! Please let me know if I can assist you with anything else. Else, feel free to accept my answer as a solution to the question. Thanks!