Sha256: 5b58f9b99ea73140781f7f4068219cf9bec3b0be8e00db33d68e370f20eb04e2
Contents?: true
Size: 1.15 KB
Versions: 9
Compression:
Stored size: 1.15 KB
Contents
---
title: HeartBeatRule
---
## PureCloud::HeartBeatRule
## Properties
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
| **name** | **String** | Name of the rule | |
| **sender_id** | **String** | The value that identifies the sender of the heartbeat. | |
| **heart_beat_timeout_in_minutes** | **Integer** | The number of minutes to wait before alerting missing heartbeats. | |
| **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
| **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
| **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
| **alert_types** | **Array<String>** | A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']. | |
| **rule_type** | **String** | The type of system the will be generating the heartbeat. | |
| **self_uri** | **String** | The URI for this object | [optional] |
{: class="table table-striped"}
Version data entries
9 entries across 9 versions & 1 rubygems