Skip to main content
Read and change how OpenCX hands sessions to Genesys Cloud, list the queues synced from your Genesys organization, and check the health of the connection. Connecting Genesys Cloud and changing credentials happen in Settings → Ticketing; see Connect Genesys Cloud.

​
Key Concepts

  • Scopes — reads need genesys-settings:read; updates need genesys-settings:write
  • Not connected — reads answer 200 with connected: false and an empty result; updates answer 400
  • Partial updates — omitted fields keep their value
  • Credentials — read-only here; the client secret is never returned
  • Smart routing — cannot be combined with a pinned queue or agent target; that update answers 400

​
Available Endpoints

Get settings

Read the Genesys Cloud connection and handoff settings.

Update settings

Change the Genesys Cloud handoff settings. Omitted fields keep their value.

List queues

List the queues from the last directory sync and the team each is linked to.

Get health

Read the health signals, objectives, drift and last repair of the connection.