Freshdesk HipChat addon is a middleware app to notify the HipChat room when tickets in freshdesk are created or updated.
This integration is written as a rails app. The tutorial explains deploying the app on heroku--alternatively, you can deploy this in any other host. The app must be web-accessible (cannot run in a internal network / localhost). After deploying, HipChat needs to be configured--covered in section after deployment.
- Signup for Heroku.
- Download Heroku Toolbelt. This is the heroku commandline tool.
- Clone the freshdesk hipchat addon from github with
git clone [email protected]:freshdesk/hipchat_freshdesk_addon.git. - Edit
config/environment.rband change theENV["DOMAIN"]with the heroku app name, eg http://your-hipchat-addon.herokuapp.com. - Do
git init. - Do
git add . - Do
git commit -m "Initial import of freshdesk hipchat addon" - Do
heroku login - Once authenticated, you will be requested to configure and share your public key with heroku.
- Do
heroku create <your-hipchat-addon>.<your-hipchat-addon>is the app name in heroku also which is mentioned inenvironment.rb. - Do
git push heroku master - Do
heroku logsto see the logs from heroku.
To test if the addon is deployed successfully, point your browser to http://your-hipchat-addon.herokuapp.com/hipchat. You should see a JSON response.
- Login to HipChat. Go to the rooms tab, and select the room where Freshdesk notifications needs to be published.
- Select Integrations menu link in the left navigation.
- Click on the link Build and install your own integration.
- You will be prompted to provide the integration URL. Give the URL
http://your-hipchat-addon.herokuapp.com/hipchat. Click on Add integration. - You will be shown the Freshdesk configuration screen, where you need to provide:
- Freshdesk domain and API key.
- Choose on what event the notifications must be triggered--only on ticket create or on update too.