/genesys-alerts | Type: Application | PCID required: Yes
Tools
genesys_alerts_delete_alerting_alert
Delete an alert Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertId | string | Yes | — | Alert ID |
genesys_alerts_delete_alerting_alerts_all
Delete all alerts for the usergenesys_alerts_delete_alerting_rule
Delete a rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ruleId | string | Yes | — | Rule Id |
genesys_alerts_delete_processautomation_trigger
Delete a Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
triggerId | string | Yes | — | triggerId |
genesys_alerts_get_alerting_alert
Get an alert Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertId | string | Yes | — | Alert ID |
genesys_alerts_get_alerting_rule
Get a rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ruleId | string | Yes | — | Rule Id |
genesys_alerts_get_processautomation_trigger
Retrieve a single Trigger matching id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
triggerId | string | Yes | — | triggerId |
genesys_alerts_get_processautomation_triggers
Retrieves all triggers, optionally filtered by query parameters. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
topicName | string | No | — | Topic name(s). Separated by commas |
enabled | boolean | No | — | Boolean indicating desired enabled state of triggers |
hasDelayBy | boolean | No | — | Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set. |
genesys_alerts_get_processautomation_triggers_topics
Get topics available for organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
genesys_alerts_patch_alerting_alert
Allows an entity to mute/snooze an alert or update the unread status of the alert. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertId | string | Yes | — | Alert ID |
dateEnd | string | No | — | The end date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateStart | string | No | — | The start date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
type | string | No | — | The action being taken on the alert. |
unread | object | No | — | unread |
validRequest | boolean | No | — | validRequest |
genesys_alerts_patch_alerting_alerts_all
Updates all alerts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | No | — | The action to take |
unread | object | No | — | unread |
genesys_alerts_post_alerting_alerts_query
Gets a paged list of alerts. The max page size is 50 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertStatus | string | No | — | The status of the alerts the query will return. |
pageNumber | integer | No | — | The page number of the queried response |
pageSize | integer | No | — | The number of entities to return of the queried response. The max is 25 |
queryType | string | No | — | The type of query being performed. |
ruleType | string | No | — | The rule type of the alerts the query will return |
sortBy | string | No | — | The field to sort responses by. The accepted choices are Name and DateStart |
sortOrder | string | No | — | The order in which response will be sorted. The accepted choices are Asc and Desc |
viewedStatus | string | No | — | The view status of the alerts the query will return. |
genesys_alerts_post_alerting_rules
Create a Rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conditions | object | No | — | conditions |
dateCreated | string | No | — | The creation date of the rule when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateLastModified | string | No | — | The timestamp of the last update to the rule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | No | — | The description of the rule. |
enabled | boolean | No | — | Indicates if the rule is enabled. |
id | string | No | — | The globally unique identifier for the object. |
inAlarm | boolean | No | — | Indicates if the rule is in alarm state. |
name | string | Yes | — | Name of the rule |
notifications | any[] | No | — | The alert notification types to trigger when alarm state changes as well as the users they will be sent to. |
selfUri | string | No | — | The URI for this object |
sendExitingAlarmNotifications | boolean | No | — | Indicates if the alert will send a notification when it is closed. |
type | string | Yes | — | The type of the rule. |
user | object | No | — | user |
version | integer | No | — | The current version number of the rule. |
waitBetweenNotificationMs | integer | No | — | The amount of time in milliseconds to wait between notification. |
genesys_alerts_post_alerting_rules_query
Get a paged list of rules. The max size of the page is 50 items. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enabledType | string | No | — | The state of the rule the query will return. The accepted choices are Enabled, Disabled, or All |
nameSearchType | string | No | — | Specifies how strict the name search needs to be. Expected values are Exact and Contains if querying by name. |
pageNumber | integer | No | — | The page number of the queried response |
pageSize | integer | No | — | The number of entities to return of the queried response. The max is 25 |
queryType | string | No | — | The type of query being performed. |
ruleName | string | No | — | The name of the rule being queries. |
ruleType | string | No | — | The rule type of the alerts the query will return |
sortBy | string | No | — | The field to sort responses by. The accepted choices are Name and DateStart |
sortOrder | string | No | — | The order in which response will be sorted. The accepted choices are Asc and Desc |
genesys_alerts_post_processautomation_trigger_test
Test the matching of a Trigger based on provided event body Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
triggerId | string | Yes | — | triggerId |
body | string | No | — | eventBody |
genesys_alerts_post_processautomation_triggers
Create a Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
delayBySeconds | integer | No | — | Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set. |
description | string | No | — | Description of the trigger. Can be up to 512 characters in length. |
enabled | boolean | Yes | — | Boolean indicating if Trigger is enabled |
eventTTLSeconds | integer | No | — | Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set. |
matchCriteria | any[] | No | — | The configuration for when a trigger is considered to be a match for an event. When not provided, all events will fire the trigger |
name | string | Yes | — | The name of the trigger |
target | object | Yes | — | The target of a trigger invocation |
topicName | string | Yes | — | The topic that will cause the trigger to be invoked. Cannot be updated after creation. Valid topics can be found at /processautomation/triggers/topics |
genesys_alerts_post_processautomation_triggers_topic_test
Test the matching of all organization Triggers on given topic using provided event body Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
topicName | string | Yes | — | topicName |
body | string | No | — | eventBody |
genesys_alerts_put_alerting_alert
Update an alert read status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertId | string | Yes | — | Alert ID |
unread | boolean | No | — | True is alert is unread, false if it has not been. |
genesys_alerts_put_alerting_rule
Update a rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ruleId | string | Yes | — | Rule Id |
conditions | object | No | — | conditions |
description | string | No | — | The description of the rule. |
enabled | boolean | No | — | Indicates if the rule is enabled. |
id | string | No | — | The globally unique identifier for the object. |
name | string | Yes | — | Name of the rule |
notifications | any[] | No | — | The alert notification types to trigger when alarm state changes as well as the users they will be sent to. |
selfUri | string | No | — | The URI for this object |
sendExitingAlarmNotifications | boolean | No | — | Indicates if the alert will send a notification when it is closed. |
waitBetweenNotificationMs | integer | No | — | The amount of time in milliseconds to wait between notification. |
genesys_alerts_put_processautomation_trigger
Update a Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
triggerId | string | Yes | — | triggerId |
delayBySeconds | integer | No | — | Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set. |
description | string | No | — | Description of the trigger. Can be up to 512 characters in length. |
enabled | boolean | Yes | — | Boolean indicating if Trigger is enabled |
eventTTLSeconds | integer | No | — | Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set. |
matchCriteria | any[] | No | — | The configuration for when a trigger is considered to be a match for an event |
name | string | Yes | — | The name of the trigger |
target | object | Yes | — | The target of a trigger invocation |
topicName | string | Yes | — | The topic that will cause the trigger to be invoked. Must match existing trigger topicName. |
version | integer | Yes | — | Version of this trigger |

