Guides
Guides

Shure

Shure connector setup guide.

Overview

Authorization to ShureCloud is done via API client credentials — a Client ID and Client Secret — generated for an integration that has access to the devices you want to monitor. You create the integration inside ShureCloud, copy its credentials, and paste them into the Shure connector's API Configuration screen in Xyte.

API Access Requirements

To use the ShureCloud REST API with Xyte, make sure you have:

  • Required account / tenant: A ShureCloud organization, accessed with a My Shure ID.
  • Required access: API access enabled for your organization, with permission to create API integrations / applications.
  • Required plan / license: Depends on your ShureCloud deployment and entitlements.
  • Where to verify: ShureCloud organization → Organization Settings > ShureCloud API.

Get your API credentials

Follow these steps in ShureCloud to generate the Client ID and Client Secret, then enter them in Xyte.

Step 1 — Sign in to ShureCloud

Open ShureCloud and sign in with a My Shure ID that can manage API access for your organization. Navigate to the API / Developer integrations area.

Step 2 — Create an integration

Click + Create integration. In the dialog:

  1. Enter a Name (for example, Xyte).
  2. Enter a Description (optional, e.g., Xyte monitoring).
  3. Tick Agree to the Developer Terms of Service.
  4. Click Create integration.
Create integration in ShureCloud

Step 3 — Open the integration details

Find your new integration in the list. Click the ⋯ (three-dot) menu on its row and choose View details.

Open the integration's View details menu

Step 4 — Copy the Client ID and Secret

In the integration details you'll see an App client containing a Client ID and a Secret:

  1. Copy the Client ID (use the copy icon next to it).
  2. Click the eye icon to reveal the Secret, then copy it with the copy icon.
App client Client ID and Secret in ShureCloud
📌

Store the Secret now. The Secret may be shown only at this stage. If you lose it, you'll need to reset/regenerate it (which invalidates the old one). If you ever need an additional credential pair, use Add app client.

Step 5 — Enter the credentials in Xyte

Back in the Shure connector's API Configuration screen in Xyte:

  1. Paste the value into the Client ID field.
  2. Paste the value into the Client secret field (use the eye icon to verify it pasted correctly).
  3. Save / connect.
Enter Client ID and Client secret in Xyte

For full API details, see the Shure REST API documentation.

These credentials are stored securely on Xyte servers and are used only to authenticate with ShureCloud on your behalf.

Notes

  • Store the Client Secret when it is first shown. Many platforms display the secret only once at creation; if it is lost, you must reset/regenerate it (which invalidates the old secret).
  • If 2FA or SSO restrictions are enabled on your ShureCloud account, use a dedicated API integration rather than personal login credentials, or coordinate with your Xyte representative.

Additional information

Connector root space name: shure

If deleted and re-added:

⚠️

Deleting this connector will remove all imported devices and their data. This action cannot be undone.

  • A new connector will be created upon re-adding.
  • If the name ShureCloud already exists, the new connector will be named ShureCloud 1.
  • The device tree will be re-imported under the new connector.
  • The tree hierarchy will not be deleted.