hubot-untappd-friends
v1.11.1
Published
Get the latest checkins from your Untappd friends.
Downloads
50
Maintainers
Readme
Untappd Friends for Hubot
Get the latest check-ins from your Untappd friends.
Getting Started
[!NOTE] As of January 2024, the Untappd API is still not accepting new applications. :cry:
You will first need to go through the process of applying for an API key. This can take anywhere from 2-3 weeks, and you will need to explain for what you intend to use the API key. You can send a link to this page and say you want to use this package.
From here, it can be a little frustrating. Take a look at the documentation. It uses an OAuth1 workflow to send data back the specified endpoint, which you then need to exchange again to get an access token. Postman is a great tool to generate the UNTAPPD_API_ACCESS_TOKEN
by plugging in your API credentials.
Installation
In your hubot repository, run:
npm install hubot-untappd-friends --save
Then add hubot-untappd-friends to your external-scripts.json
:
["hubot-untappd-friends"]
Configuration:
| Variable | Required? | Description |
| -------------------------------- | :-------: | ---------------------------------------------------------------- |
| UNTAPPD_API_KEY
| Yes | Client ID for your integration |
| UNTAPPD_API_SECRET
| Yes | Client Secret for your integration |
| UNTAPPD_API_ACCESS_TOKEN
| Yes | OAuth 2.0 access token |
| UNTAPPD_MAX_COUNT
| No | Number of beers to show; default: 5
|
| UNTAPPD_MAX_DESCRIPTION_LENGTH
| No | Where to truncate long descriptions, 0
to hide; default: 150
|
| UNTAPPD_MAX_RANDOM_ID
| No | Maximum value to use for random beer command |
Commands:
hubot untappd
- Recent friend activityhubot untappd badges
- Recent friends' badge activityhubot untappd user <username>
- Get stats about a particular userhubot untappd beer random
- Retrieve a random beerhubot untappd beer <query|ID>
- Get data about a particular beerhubot untappd brewery <query>
- Get data about a particular breweryhubot untappd toast
- Have the bot toast the most recent checkin from each user in activity feedhubot untappd toast <username>
- Have the bot toast user's most recent checkinhubot untappd register
- Instructions to register with the bothubot untappd approve
- Approve all pending friend requestshubot untappd friends
- List the bot's friendshubot untappd remove <username>
- Remove a friend