Configuring Hipex Notifications
How do I configure Hipex Notifications to stay on top of important events?
Introduction
With the Hipex Notifications we enable you to be on top of important events related to your servers and applications. Such as expiring SSL certificates, disks that are running out of storage and daily performance scan results. To make use of notifications, they'll have to be configured in the Pack Control Panel first. Notifications are always configured on the organization level, not per user.
In this article, we help you with setting up Hipex Notifications for your needs.
Prerequisites
- A Hipex account to log in to the Pack Control Panel
- You are part of the organization where you'd like to configure notifications for.(If this is not the case please contact our support)
Configuring notifications in the Pack Control Panel
1. Select the organization
Log in to Pack Control Panel with your Hipex account and make sure you select the organization, either by using the application picker (left top) or the organization switcher (right top).
2. Go to Notifications
Navigate to Notifications in the navigation bar under the "general" section.
3. Create Configurations
With Notifications Management we allow you to create multiple configurations and be as flexible as possible. We don't make any assumptions on what and how you should get notifications, because requirements are different per organization.
A notification configuration consists of two parts:
- a pattern
- one or multiple targets
The pattern is used for matching notifications by their type. Here are two examples of currently implemented notification types:
/server/disk/usage/almost-full
/application/ssl/almost-expired
/perfscan/scanned
Because we support the use of wildcards (*), it's possible to just create one configuration with * as pattern. In reality, this won't be very useful. It makes more sense to make more specific configurations, such as separate ones for application, user and server notifications. We're adopting a predictable naming convention (/[category]/[subcategory]/[subcategory]/[event]
) to make it as easy as possible to set this up, without the need to maintain the configurations in case we implement more notifications in the future.
A good default setup could consist of the following configurations:
/application/*
- all application specific notifications, such as expiring SSL certificates/user/*
- all application/SSH user-specific notifications, such as user load warnings/server/*
- all server specific notifications, such as memory or disks almost full/perfscan/*
- all performance scan related notifications, such as daily performance scan reports.
After a configuration is created, you can further configure them by adding targets.
4. Setting up notification targets
When a configuration is triggered for a notification, it'll be sent to all targets that are configured.
Currently, we support the following targets:
- Slack Webhook: post notifications to a Slack channel, e.g.
#hipex-notifications
- Simple Webhook: integrate Hipex Notifications with your own workflow, either by creating a custom API or tools like Zapier that support incoming webhooks to trigger processes
- Email: receive notifications as emails to the specified destination address
- WhatsApp: receive notifications as WhatsApp messages, sent via our Hipex WhatsApp account
5. Receiving notifications
After you're finished with setting up the notification configurations for your organization, you're ready to receive Hipex Notifications. This will happen as soon as notifications are sent for your organization and are matching the configured patterns.