Genesys Cloud
This Integration is part of the Genesys Cloud Pack.#
Supported versions
Supported Cortex XSOAR versions: 8.4.0 and later.
Fetch audit events to see changes within a Genesys Cloud organization. This integration was integrated and tested with version 2 of the Genesys Cloud Platform API.
Configure Genesys Cloud in Cortex#
| Parameter | Description | Required |
|---|---|---|
| Server URL | Default value is https://api.mypurecloud.com/. | False |
| Client ID | True | |
| Client Secret | True | |
| Trust any certificate (not secure) | False | |
| Use system proxy settings | False | |
| Fetch Events | False | |
| Service names | Ensure all selected services appear in the audit service mapping information. Possible values are: Architect, PeoplePermissions, ContactCenter, Groups, Telephony, Outbound, Routing, Integrations, AnalyticsReporting. | False |
| Maximum number of events per service | Default value is 2500. | False |
Commands#
You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
genesys-cloud-get-events#
Retrieves audit events from Genesys Cloud from the past 14 days. This command is intended for development and debugging purposes, as it may produce duplicate events, exceed API request rate limits, and disrupt the fetch events mechanism.
Base Command#
genesys-cloud-get-events
Input#
| Argument Name | Description | Required |
|---|---|---|
| should_push_events | If true, the command will create events, otherwise it will only display them. Possible values are: true, false. Default is false. | Optional |
| service_name | Filter by the Genesys Cloud service name. Possible values are: Architect, PeoplePermissions, ContactCenter, Groups, Telephony, Outbound, Routing, Integrations, AnalyticsReporting. | Required |
| limit | Maximum number of audit events to return. | Optional |
| from_date | The start date for retrieving events. Must be within the last 14 days. Default is 1 hour ago. | Optional |
| to_date | The end date for retrieving events. Must be within the last 14 days. Default is now. | Optional |
Context Output#
There is no context output for this command.
Limitations#
- The
genesys-cloud-get-eventsis only able to retrieve events from the past 14 days. Ensure both thefrom_dateandto_datecommand arguments are within the last 14 days.