Creating an Alarm Profile

You can set up alarm profiles for each user to receive failure alerts over email, SMS and web hook during Pulse Campaigns. Alarm notifications can be sent to multiple recipients to alert them about failed test cases. You can also set up push notifications to Cyara Mobile app.

To create an Alarm Profile, perform the following steps:

From the main menu, go to Execute > Alarm Profile. The existing alarm profiles are displayed. Test Cases must be assigned to each user while creating the alarm profile.
To create a new alarm profile, from the right-hand corner, click New Profile. At the top of the page, click Enter profile name and enter a name for the alarm profile.
On the Schedule Tab, specify the acceptable Day and Time periods when recipients must receive alert messages.
If you wish to exclude a day so you do not receive any alerts on that particular day, hover over the day and a red trash icon appears in the right corner. Use the red trash icon to delete that day from the target schedule. Otherwise, you can specify the Time Period on that day during which alert messages are acceptable. The Cyara Web Portal will not send alert messages to any recipients outside of the hours specified in the User Alarm Profile.

Setting Up Push Notifications

You can receive failure alerts through push notifications to the Cyara Mobile app. To configure the push notifications, do the following:

To send failure alerts through push notification to the Cyara Pulse Mobile app, select the Receive Failure Alerts through Pulse Notifications option.
You can set the Notification Threshold values based on the number of failures in the rolling attempts window. The user will receive a failure alert through a Push Notification if the number of failures is reached within the attempts window.
In the Dashboard & Service Group Alarm Options section, you can set up alerts for all major incidents from any custom Pulse dashboard or from any specific service group in a dashboard. Select the Dashboard in the tree on the left, and a list of Service Groups appears on the right side.
To subscribe for all failures in the Service Group, select the Alert On All Major Incidents option.

Setting Up Email SMS and Web Hook Notifications

You can set up users to receive email and SMS alert messages. You can also set up a web hook and third-party incident management system integrated with Cyara Web Portal to receive alert notifications in the Email, SMS & Web Hook tab.

To set up email alert message, select the Alert By Email option and enter the receipient email addresses.
Multiple email addresses can be added to receive alert messages under a single user profile using a comma-delimited (,) list of email addresses.
To set up alert messages over SMS, select the Alert by SMS option and enter the receipient phone numbers. SMS numbers are formatted as +[country code][NPA-NXX-XXXX].

Note: The phone number format might be different for on-premise solution.

Multiple phone numbers can be added to receive alert messages under a single user profile using a comma-delimited (,) list of phone numbers.
To set up alerts from a configured incident integration application, select the Alert by Integration option and choose the application from the list of configured applications. Click Configure to add new integrations. For information about integrations, see Integration Hub.
To integrate into third party applications by calling an external URL, select the Alert by Web Hook option and enter the URL. Click Test to check whether the URL is valid.
Note: As per the screenshot above, all variables to be included in the document template must be enclosed with quotes. See below for an example document template.
```
{
	"message_type": "CRITICAL",
	"monitoring_tool": "Cyara",
	"entity_id": "$text",
	"state_message": {
		"text": "$text",
		"status": "$status",
		"dashboard": "$dashboard",
		"services": ["$services"],
		"link": "$link"
	}
}
```
Select a template from the Available Templates list. The options are:
- Custom - Includes details of all the fields available to the document.
- Slack - Includes a pre-defined template for Slack integration.
If you choose Custom template, enter the json document structure for the alert message in the Document Template field.
In the Success Threshold field, specify the number of continuous successful runs before a clearning alert must be sent.
You can configure Alarm Profiles for Pulse dashboards from the dashboard area.
The Pulse Dashboard can send two types of alerts:
1. Major: a failure, displayed as a red spot on the Dashboard.
2. Minor: result is satisfactory, displayed as an orange spot on the Dashboard.
  
  Alerts are sent when the category enters the alert state and a clearing message is sent when the category is passing and the spot goes back to green.
Select the Dashboard name in the tree on the left, and a list of Service Groups appears on the right side.
To subscribe for all failures in the Service Group, select the Alert On All Major Incidents checkbox.
To subscribe for all satisfactory issues in the Service Group, select the Alert On All Minor Incidents checkbox.
To customize the subscription, click on a Service Group in the tree on the left, and a list of Categories appears on the right side.

Note: If you want to make changes to your Dashboards and Service Groups, see Configuring Pulse Dashboard.
Alarms will be sent only when the Test Cases are assigned to the Alarm Profile. Turn the Test Cases toggle switch on and then select Test Case from the available Test Cases folder in the left sidebar.

Note: Only Voice Test Cases can be configured to send alarms.
Select the Test Case from the Available Pool on the right pane. Alternatively, use the Search Panel to retrieve the required Test Case.
Click the Add Alarm Test Case button to assign the Test Case to the profile. Repeat the procedure to add multiple Test Cases.
When the Alert On Major option is selected, an alert message is sent only in the case of a major Test Case failure. Similarly, if you select the Alert On Minor option, alert message is sent if a minor failure is encountered.
To remove a test case from the alarm profile, hover over the Test Case and click the trash icon.
Click Save Details to save the profile and close the screen.