2. Chatting with HipChat
API’S 101
Don Brown
•
Architect
•
Atlassian
•
@mrdonbrown

10. Install Bitbucket Integration
1. Google “hipchat bitbucket
integration”
10.In a separate tab, go back to
HipChat and login
2. Click first Google result
11.Click on “Group Admin” tab
3. Click “these instructions” link
12.Click on “API”
4. Click “Hipchat hook management”
link as page was renamed
13.Type in “Bitbucket integration, select
“Notifications, copy new API key
5. Visit Bitbucket and login
14.Click on the “Rooms” tab
6. Go to desired repository
15.Click on the target room
7. Click admin icon
16.Copy the “API ID” value
8. Select “Hooks” menu item
17.Go back to the Bitbucket tab
9. Select “HipChat” from hooks
dropdown list
18.Copy in ID, API key, and API url
(consult docs), and click “Save”

11. HipChat Add-Ons =
API’s + Connect +
Marketplace

12. Character Sheets
SaaS Dev
Str
Dex
Con
Int
Wis
Cha
Level
Exp
Experts Founder
Enterprise Arch
17
10
12
18
12
14
12
14
18
15
16
14
11
16
17
12
18
14
2
6
5
4,200
52,650
34,800

13. SaaS Jr. Developer
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s i on 3 - Ent re pre ne ur

14. Goal: Show signups in
my team’s room

15. Just text by itself, for
impact.

16. Just text by itself, for
impact.

17. Just text by itself, for
impact.

18. curl -H "Content-Type: application/json"
-d '{"message": "Hello world"}'
-v
"https://api.hipchat.com/v2/room/My
%20Room/message"

19. <
<
<
<
<
<
<
<
<
{
HTTP/1.1 401 Unauthorized
Server: nginx
Date: Mon, 16 Sep 2013 23:33:27 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
WWW-Authenticate: Bearer realm="HipChat"
"error": {
"code": 401,
"message": "Authenticated requests only.
See https://www.hipchat.com/docs/apiv2/auth for
more information.",
"type": "Unauthorized"
}

21. Just text by itself, for
impact.

22. Just text by itself, for
impact.

23. curl -H "Content-Type: application/json"
-d '{"message": "Hello world"}'
-v
"https://api.hipchat.com/v2/room/My
%20Room/message?
auth_token=VPNE7g0rHbfpNZ68XcOP0mwoBhwLGe9cFt
BmLFdq"

24. <
<
<
<
<
<
<
<
<
HTTP/1.1 204 No Content
Server: nginx
Date: Mon, 16 Sep 2013 23:42:31 GMT
Content-Type: text/html
Connection: keep-alive
X-Ratelimit-Remaining: 499
X-Ratelimit-Limit: 500
Access-Control-Allow-Origin: *
X-Ratelimit-Reset: 1379374980.0

28. GET https://api.hipchat.com/v2/room/Engineering
{
"created": "2013-08-08T18:42:20",
"id": 34,
...
"participants": [
{
"id": 375,
"links": {
"self": "https://api.hipchat.com/v2/user/375"
},
"name": "Garret Heaton"
}
]
}

29. GET https://api.hipchat.com/v2/room/Engineering?
expand=participants
{
"created": "2013-08-08T18:42:20",
"id": 34,
...
"participants": [
{
"created": "2013-08-08T18:42:20",
"email": "garret@example.com",
"id": 375,
"is_deleted": false,
"is_group_admin": true,
"is_guest": false,
"mention_name": "GarretHeaton",
"name": "Garret Heaton",
...
}]}

31. Just text by itself, for
impact.

32. SaaS Jr. Developer
Scenario
S e s s i on 1 - H a c ke r
S e s s on 2- Int ra pre ne ur
S e s s iion 2 - Int ra pre ne ur
S e s s i on 3 - Ent re pre ne ur

33. Goal: Show signups in
any team’s room

34. Just text by itself, for
impact.

35. Signup
DB
Signup AddOn
HipChat

36. {
"name": "Signups",
"description": "Posts signups in rooms",
"key": "com.example.signups",
"links": {
"homepage": "https://example.com/signups",
"self": "https://example.com/signups/capabilities"
},
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
}
}
}

37. Just text by itself, for
impact.

38. Just text by itself, for
impact.

39. Just text by itself, for
impact.

41. Just text by itself, for
impact.

42. Just text by itself, for
impact.

43. curl -v
!
-u d4d6949e-791e-43cea0b7-50134495b73e:j998i9niK8zhi89R2sieBVVQSFfIgzd
TOBpxI8aP
!
-d
"grant_type=client_credentials&scope=send_notific
ation"
!
https://api.hipchat.com/v2/oauth/token

44. < HTTP/1.1 200 OK
< Server: nginx
< Date: Tue, 17 Sep 2013 01:28:03 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Connection: keep-alive
< X-Ratelimit-Remaining: 499
< X-Ratelimit-Limit: 500
< Access-Control-Allow-Origin: *
< X-Ratelimit-Reset: 1379381340.0
<
{"access_token":
"E9NGsQjqWgHSK50ZXHGgIAoQ0E13b1FuGiLPNdYj",
"expires_in": 82800,
"scope": "view_group",
"token_type": "bearer"}

46. {
"name": "Signups",
"description": "Posts signups in rooms",
"key": "com.example.signups",
"links": {
"homepage": "https://example.com/signups",
"self": "https://example.com/signups/capabilities"
},
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
},
"installable": {
"callbackUrl": "https://example.com/signups/
installed"
}
}
}

48. SaaS Jr. Developer
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s on 3 -Ent re pre ne ur
S e s s iion 3 - Entre pre ne ur

49. Goal: show sales in
customer rooms

51. {
"name": "Signups",
"description": "Posts signups in rooms",
"key": "com.example.signups",
...
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
},
"installable": {
"callbackUrl": "https://example.com/signups/
installed"
},
"configurable": {
"url": "https://example.com/signups/config"
}
}
}

52. Just text by itself, for
impact.

53. Screenshot of
marketplace docs

54. Screenshot of
marketplace registration

55. Just text by itself, for
impact.

56. Just text by itself, for
impact.

57. Enterprise Architect
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s i on 3 - Ent re pre ne ur

58. Goal: Show sales in my
dev team’s room

59. Just text by itself, for
impact.

60. Just text by itself, for
impact.

61. Just text by itself, for
impact.

62. curl -H "Content-Type: application/json"
-d '{"message": "Hello world"}'
-v
"https://api.hipchat.com/v2/room/My
%20Room/message"

63. <
<
<
<
<
<
<
<
<
{
HTTP/1.1 401 Unauthorized
Server: nginx
Date: Mon, 16 Sep 2013 23:33:27 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
WWW-Authenticate: Bearer realm="HipChat"
"error": {
"code": 401,
"message": "Authenticated requests only.
See https://www.hipchat.com/docs/apiv2/auth for
more information.",
"type": "Unauthorized"
}

65. Just text by itself, for
impact.

66. Just text by itself, for
impact.

67. curl -H "Content-Type: application/json"
-d '{"message": "Hello world"}'
-v
"https://api.hipchat.com/v2/room/My
%20Room/message?
auth_token=VPNE7g0rHbfpNZ68XcOP0mwoBhwLGe9cFt
BmLFdq"

68. <
<
<
<
<
<
<
<
<
HTTP/1.1 204 No Content
Server: nginx
Date: Mon, 16 Sep 2013 23:42:31 GMT
Content-Type: text/html
Connection: keep-alive
X-Ratelimit-Remaining: 499
X-Ratelimit-Limit: 500
Access-Control-Allow-Origin: *
X-Ratelimit-Reset: 1379374980.0

72. GET https://api.hipchat.com/v2/room/Engineering
{
"created": "2013-08-08T18:42:20",
"id": 34,
...
"participants": [
{
"id": 375,
"links": {
"self": "https://api.hipchat.com/v2/user/375"
},
"name": "Garret Heaton"
}
]
}

73. GET https://api.hipchat.com/v2/room/Engineering?
expand=participants
{
"created": "2013-08-08T18:42:20",
"id": 34,
...
"participants": [
{
"created": "2013-08-08T18:42:20",
"email": "garret@example.com",
"id": 375,
"is_deleted": false,
"is_group_admin": true,
"is_guest": false,
"mention_name": "GarretHeaton",
"name": "Garret Heaton",
...
}]}

75. Just text by itself, for
impact.

76. Enterprise Architect
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s i on 3 - Ent re pre ne ur

77. Goal: Show sales in any
team’s room

78. Just text by itself, for
impact.

79. Sales DB
Sales Add-On
HipChat

80. {
"name": "Sales Info",
"description": "Posts sales to rooms",
"key": "com.example.sales",
"links": {
"homepage": "https://example.com/sales",
"self": "https://example.com/sales/capabilities"
},
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
}
}
}

81. Just text by itself, for
impact.

82. Just text by itself, for
impact.

83. Just text by itself, for
impact.

85. Just text by itself, for
impact.

86. Just text by itself, for
impact.

87. curl -v
!
-u d4d6949e-791e-43cea0b7-50134495b73e:j998i9niK8zhi89R2sieBVVQSFfIgzd
TOBpxI8aP
!
-d
"grant_type=client_credentials&scope=send_notific
ation"
!
https://api.hipchat.com/v2/oauth/token

88. < HTTP/1.1 200 OK
< Server: nginx
< Date: Tue, 17 Sep 2013 01:28:03 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Connection: keep-alive
< X-Ratelimit-Remaining: 499
< X-Ratelimit-Limit: 500
< Access-Control-Allow-Origin: *
< X-Ratelimit-Reset: 1379381340.0
<
{"access_token":
"E9NGsQjqWgHSK50ZXHGgIAoQ0E13b1FuGiLPNdYj",
"expires_in": 82800,
"scope": "view_group",
"token_type": "bearer"}

90. {
"name": "Sales Info",
"description": "Posts sales to rooms",
"key": "com.example.sales",
"links": {
"homepage": "https://example.com/sales",
"self": "https://example.com/sales/capabilities"
},
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
},
"installable": {
"callbackUrl": "https://example.com/sales/
installed"
}
}
}

92. Enterprise Architect
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s on 3 -Ent re pre ne ur
S e s s iion 3 - Entre pre ne ur

93. Goal: Create side-project
to show Stripe sales in
customer rooms

95. {
"name": "Stripe Integration",
"description": "Posts credit card sales in rooms",
"key": "com.example.stripe",
...
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
},
"installable": {
"callbackUrl": "https://example.com/stripe/
installed"
},
"configurable": {
"url": "https://example.com/stripe/config"
}
}
}

96. Just text by itself, for
impact.

97. Screenshot of
marketplace docs

98. Screenshot of
marketplace registration

99. Just text by itself, for
impact.

100. Just text by itself, for
impact.

101. Experts Founder
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s i on 3 - Ent re pre ne ur

102. Goal: Add external chat
room to website

103. Just text by itself, for
impact.

104. Just text by itself, for
impact.

105. Just text by itself, for
impact.

106. curl -H "Content-Type: application/json"
-d '{"message": "Hello world"}'
-v
"https://api.hipchat.com/v2/room/My
%20Room/message"

107. <
<
<
<
<
<
<
<
<
{
HTTP/1.1 401 Unauthorized
Server: nginx
Date: Mon, 16 Sep 2013 23:33:27 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
WWW-Authenticate: Bearer realm="HipChat"
"error": {
"code": 401,
"message": "Authenticated requests only.
See https://www.hipchat.com/docs/apiv2/auth for
more information.",
"type": "Unauthorized"
}

109. Just text by itself, for
impact.

110. Just text by itself, for
impact.

111. curl -H "Content-Type: application/json"
-d '{"message": "Hello world"}'
-v
"https://api.hipchat.com/v2/room/My
%20Room/message?
auth_token=VPNE7g0rHbfpNZ68XcOP0mwoBhwLGe9cFt
BmLFdq"

112. <
<
<
<
<
<
<
<
<
HTTP/1.1 204 No Content
Server: nginx
Date: Mon, 16 Sep 2013 23:42:31 GMT
Content-Type: text/html
Connection: keep-alive
X-Ratelimit-Remaining: 499
X-Ratelimit-Limit: 500
Access-Control-Allow-Origin: *
X-Ratelimit-Reset: 1379374980.0

116. GET https://api.hipchat.com/v2/room/Engineering
{
"created": "2013-08-08T18:42:20",
"id": 34,
...
"participants": [
{
"id": 375,
"links": {
"self": "https://api.hipchat.com/v2/user/375"
},
"name": "Garret Heaton"
}
]
}

117. GET https://api.hipchat.com/v2/room/Engineering?
expand=participants
{
"created": "2013-08-08T18:42:20",
"id": 34,
...
"participants": [
{
"created": "2013-08-08T18:42:20",
"email": "garret@example.com",
"id": 375,
"is_deleted": false,
"is_group_admin": true,
"is_guest": false,
"mention_name": "GarretHeaton",
"name": "Garret Heaton",
...
}]}

120. Just text by itself, for
impact.

121. Experts Founder
Scenario
S e s s i on 1 - H a c ke r
S e s s on 2- Int ra pre ne ur
S e s s iion 2 - Int ra pre ne ur
S e s s i on 3 - Ent re pre ne ur

122. Goal: Private support
chats on website

123. Just text by itself, for
impact.

124. Support
DB
Support AddOn
HipChat

125. {
"name": "Support Chats",
"description": "Manages support chats",
"key": "com.example.support",
"links": {
"homepage": "https://example.com/support",
"self": "https://example.com/support/capabilities"
},
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
}
}
}

126. Just text by itself, for
impact.

127. Just text by itself, for
impact.

128. Just text by itself, for
impact.

130. Just text by itself, for
impact.

131. Just text by itself, for
impact.

132. curl -v
!
-u d4d6949e-791e-43cea0b7-50134495b73e:j998i9niK8zhi89R2sieBVVQSFfIgzd
TOBpxI8aP
!
-d
"grant_type=client_credentials&scope=send_notific
ation"
!
https://api.hipchat.com/v2/oauth/token

133. < HTTP/1.1 200 OK
< Server: nginx
< Date: Tue, 17 Sep 2013 01:28:03 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Connection: keep-alive
< X-Ratelimit-Remaining: 499
< X-Ratelimit-Limit: 500
< Access-Control-Allow-Origin: *
< X-Ratelimit-Reset: 1379381340.0
<
{"access_token":
"E9NGsQjqWgHSK50ZXHGgIAoQ0E13b1FuGiLPNdYj",
"expires_in": 82800,
"scope": "view_group",
"token_type": "bearer"}

135. {
"name": "Support Chats",
"description": "Manages support chats",
"key": "com.example.support",
"links": {
"homepage": "https://example.com/support",
"self": "https://example.com/support/capabilities"
},
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
},
"installable": {
"callbackUrl": "https://example.com/support/
installed"
}
}
}

137. Experts Founder
Scenario
S e s s i on 1 - H a c ke r
S e s s i on 2 - Int ra pre ne ur
S e s s on 3 -Ent re pre ne ur
S e s s iion 3 - Entre pre ne ur

138. Goal: Sell support chats
in the Marketplace

140. {
"name": "Support Chats",
"description": "Manages support chats",
"key": "com.example.support",
...
"capabilities": {
"hipchatApiConsumer": {
"scopes": [ "send_notification" ]
},
"installable": {
"callbackUrl": "https://example.com/support/
installed"
},
"configurable": {
"url": "https://example.com/support/config"
}
}
}

141. Just text by itself, for
impact.

142. Screenshot of
marketplace docs

143. Screenshot of
marketplace registration

144. Just text by itself, for
impact.

145. Just text by itself, for
impact.

146. Install Bitbucket Add-on
1.Visit HipChat and login
2.Click on “Rooms” tab
3.Click on desired room
4.Click on “Add-ons”
5.Find Bitbucket addon, and click “Install”
6.Type the repository name, and click “Add”

147. Just text by itself, for
impact.

148. The Future. . .

149. Page title here
• Level One
• Level Two
• Level Two
• Level Two
• Level One

152. Feedback time!

153. “
Be the hero! Hack HipChat!
”

154. Thank you!
Don Brown
•
Architect
•
Atlassian
•
@mrdonbrown

155. Rate this Talk
Chatting with HipChat: APIs 101
Text code below to 22333
or visit http://bit.ly/1dPD0tv
MEH = 5
NO T BA D = 6
P R ET T Y GO O D = 7
A WES O ME = 8
To join this session, send text 136888 to