XMPP Card Custom Stanza


I am the author of a xmpp chatbot that uses HipChat. I am trying to send a custom stanza using xmpp to create an application card (https://developer.atlassian.com/hipchat/guide/sending-messages) instead of using the rest api. I cannot find any documentation on how to do this. I see that HipChat supports xhtml-im (per https://answers.atlassian.com/questions/38838139) but I do not know what the server expects to create an application card.

I am able to create the application card through the rest api with the following json payload:

  "color": "purple", 
  "message_format": "text", 
  "message": "my message",
  "notify": false,
  "card": {
    "style": "application",
    "format": "compact",
    "url": "https://www.atlassian.com",
    "id": "c253adc6-11fa-4941-ae26-7180d67e814a",
    "title": "My Title",
    "description": "My description",
    "date": 1453867674631,
    "thumbnail": {
      "url": "https://www.atlassian.com/docroot/wac/resources/wac/img/social-icons/atlassian_logo.jpg",
      "url@2x": "https://www.atlassian.com/docroot/wac/resources/wac/img/social-icons/atlassian_logo.jpg",
      "width": 400,
      "height": 200
    "attributes": [
        "label": "swapv3",
        "value": {
          "label": "test",
          "url": "https://answers.atlassian.com"
        "label": "console",
        "value": {
          "label": "link2",
          "url": "https://answers.atlassian.com"


I can see my xmpp client receiving the following stanza after sending the above:

<message from="a_jabber_channel_id" type="groupchat" to="other_jabber_channel_id">
  <body>my message</body>
  <x xmlns="http://hipchat.com/protocol/muc#room">
      <raw>{"style": "application", "description": "My description", "format": "compact", "url": "https://www.atlassian.com", "title": "My Title", "id": "c253adc6-11fa-4941-ae26-7180d67e814a", "date": 1453867674631, "attributes": [{"value": {"url": "https://answers.atlassian.com", "label": "test"}, "label": "swapv3"}, {"value": {"url": "https://answers.atlassian.com", "label": "link2"}, "label": "console"}], "validation": {"safehtmls": ["activity.html"], "safeurls": ["url", "images.image", "images.image-small", "images.image-big", "icon.url", "icon.url@2x", "icon", "thumbnail.url@2x", "thumbnail.url"]}, "thumbnail": {"url": "https://www.atlassian.com/docroot/wac/resources/wac/img/social-icons/atlassian_logo.jpg", "width": 400, "url@2x": "https://www.atlassian.com/docroot/wac/resources/wac/img/social-icons/atlassian_logo.jpg", "height": 200}}</raw>
    <notification_sender type="user" id="jabber_id" />

The question is.. how can I construct a valid xmpp stanza to mimic the rest api?


1 answer

1 accepted

0 vote

Unfortunately, generating card-style messages is only possible through the API interface. The XMPP interface is limited to text/html formats. In order to generate a card message, clients can either call the API directly, or perform some kind of interaction with an addon, which then sends the card message on behalf of the client.

Thanks for the reply Chris.

Suggest an answer

Log in or Join to answer
Community showcase
Maarten Cautreels
Published Oct 07, 2017 in Hipchat

Bringing Structure to your HipChat Instance

...have mention name FirstnameLastname. Fe.: @MaartenCautreels This certainly helps to know who is being mentioned in a conversation. Imagine your colleague sends the following message...

470 views 1 4
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
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot