Knowledge base

HipChat Hooks

HipChat hooks are the simplest way to receive real-time updates about your account activity right into your HipChat rooms.
To use HipChat hooks, you will have to you'll need to generate (or reuse) a HipChat API v2 token to be used by Xplenty to post content into your HipChat room. After the hook is created, your HipChat room will be sent notifications every time the events are taking place.

Creating HipChat Hooks

HipChat hooks are defined at the account level by account administrators. Here are step-by-step instructions on how to create a HipChat hook.
  1. Click your avatar, then click Account settings
  2. Click Service Hooks from the left pane menu.
  3. Click + new hook.
  4. In the list, choose HipChat.
  5. Enter a valid API token. Here's where you can find it.
  6. Enter the name of the room to post in.
  7. Select the events you want to be notified about using this webhook:
      All Job Notifications: All events below.
      • Job Submitted: Job was submitted by user or schedule for execution.
      • Job Started: Job execution started.
      • Job Stopped: Job stopped by user.
      • Job Completed: Job completed successfully.
      • Job Failed: Job completed with failure.
    • All Cluster Notifications: All events below.
      • Cluster Requested: Cluster creation requested by user or schedule.
      • Cluster Available: Cluster is available and jobs can be run on it.
      • Cluster Terminated: Cluster is terminated.
      • Cluster Idled: No activity on the cluster for a specified interval.
      • Cluster Error: Cluster error occurred and jobs can't be executed on it.
  8. By default, the HipChat hook is created active but you can disable it if you wish.
  9. Click create service hook to save your changes.
  10. You can trigger a ping event to test the hook.
That's it! You are ready to get real-time notifications right into your HipChat room.

Note: Xplenty is using minimal permission required to send room notifications ("send_ notifications" scope). No read permissions are granted.