> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Logitech Sync

> Connect Serval to Logitech Sync so workflows can look up and manage the rooms, desks, and Logitech devices in your Sync Portal organization through the Sync Cloud API.

## About Logitech Sync

Logitech Sync is Logitech's service for managing video conferencing devices, such as Rally systems, across your meeting rooms and desks. Admins work in Sync Portal. This integration connects Serval to one Sync organization through the Sync Cloud API, so workflows can look up rooms, desks, and devices with their status, and act on them.

> [!NOTE]
>
> The Sync Cloud API is available only to organizations with a Sync Plus, Essential, or Select license, or an active trial. Organizations on a Basic license don't have access to it.

**Authentication:** A client certificate and private key generated in Sync Portal, plus your Sync Organization ID. The Sync Cloud API authenticates with mutual TLS: Serval presents the certificate when it connects to `api.sync.logitech.com`, and requests carry no token or API key. Serval stores the certificate and key encrypted and uses them only for connections to `api.sync.logitech.com`, so workflows never handle them.

**Data sync:** No background sync starts when you connect, and there are no installable ingestion workflows. Data access is on demand through workflows.

## What the Logitech Sync integration enables

| Capability | Description |
| - | - |
| Sync Cloud API access | Workflows use the "Logitech Sync API request" action to read places (rooms and desks with their devices and live status), rooms, devices, groups, locations, calendar resources, update channels, and provisioning profiles. The action is typed from version 1.0.8 of Logitech's Sync Cloud API specification. |
| Room and device management | The same action can create, update, and delete rooms and groups, link calendar resources to rooms, move devices between rooms, change camera settings, reboot devices, and start software updates. |
| Organization scoping | Serval adds the Organization ID saved on the connection to every request path, so workflows never pass it themselves. |
| Connection health check | A built-in check confirms that Sync accepts the certificate and that the organization can use the API. |

## Get your credentials

Serval needs three values from Sync Portal: a certificate, its private key, and your Organization ID.

**1. Open the Sync Cloud API settings**

Sign in to Sync Portal, select **Settings** in the left navigation, and open the **Sync Cloud API** tab.

**2. Generate a certificate**

In the top section, select **Generate new certificate**. Sync creates a certificate (`certificate.pem`) and a private key (`privateKey.pem`). Download both files and store the private key securely, never in plain text or in a code repository.

**3. Copy your Organization ID**

Scroll down past the **Sync API client certificates** panel and copy your **Org ID**.

**4. Check the API server**

Under **API Servers**, confirm that your API server is `api.sync.logitech.com`. That's the server Serval connects to.

> [!NOTE]
>
> Sync supports only two certificates at a time in one Sync account. Serval doesn't restrict the API request action to reading: it can also send `POST`, `PUT`, `PATCH`, and `DELETE` requests that reboot devices, start software updates, change device settings, or delete rooms and devices. What the certificate may do in Sync is the only limit, so protect it like an admin credential.

## Connect in Serval

**1. Open the Logitech Sync connect form**

Add a new Logitech Sync connection from your Serval integrations page.

**2. Enter the Organization ID**

Paste the Org ID you copied from Sync Portal. It can contain only letters, numbers, dashes, and underscores.

**3. Paste the certificate**

In **Certificate (certificate.pem)**, paste the whole contents of `certificate.pem`, including the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines.

**4. Paste the private key**

In **Private key (privateKey.pem)**, paste the whole contents of `privateKey.pem`, including its BEGIN and END lines. The key is shown masked after saving.

**5. Save, then check the health check**

Saving checks that the certificate and private key are a matching pair, but doesn't contact Logitech Sync. The health check runs automatically after you connect: confirm it passes before you build workflows.

> [!TIP]
>
> To rotate the certificate, generate a new one in Sync Portal, edit the connection, paste both the new certificate and its new private key, and confirm the health check passes. Then deactivate or delete the old certificate in Sync Portal. If you paste only the new certificate, saving fails, because it doesn't match the stored private key.

## Verifying the connection

The connection ships one health check that makes a live call to Logitech Sync:

* **List Logitech Sync Places:** reads one licensed room or desk. When it passes, Sync accepted the certificate for your Organization ID and the organization's license lets it use the API. On success the message reads "Successfully reached Logitech Sync (places visible: 1)."

The check reads at most one place, so the count is never higher than 1. `places visible: 0` means the connection works but Sync returned no licensed room or desk.

When the check fails, its message starts "Unable to reach Logitech Sync" and the error details show the HTTP status that Sync returned. The sections below explain the common ones.

## Gotchas and troubleshooting

> [accordion] The health check fails with HTTP 403
>
> Logitech returns 403 when the certificate is invalid or inactive. In Sync Portal, check that the certificate is still active and hasn't expired, and that the Organization ID on the connection matches the Org ID on the **Sync Cloud API** tab. If you generated a new certificate, paste both the certificate and its private key into the connection.

> [accordion] The health check fails with HTTP 402 and NOT\_ENTITLED
>
> The organization has no licensed room or desk and no active trial, so Sync refuses every API call. Assign a Sync Plus, Essential, or Select contract to at least one room or desk. Sync can also return 402 for a licensed room when its contract doesn't include the feature a request uses: for example, Select and Essential contracts entitle a room to Room Booking and Insights.

> [accordion] Saving fails because the certificate and private key don't match
>
> Serval checks the pair when you save. The check fails when the private key belongs to a different certificate, when a file is pasted only in part or without its BEGIN and END lines, or when you paste a new certificate while the connection keeps its stored private key. Paste both files from the same certificate.

> [accordion] Serval connects only to api.sync.logitech.com
>
> The connection always sends requests to `api.sync.logitech.com`. If Sync Portal lists a different API server for your organization, contact support before you connect.

> [accordion] Rooms, desks, or IDs are missing from place results
>
> `GET /place` returns licensed rooms and desks only. Pass `unlicensed=true` to include unlicensed ones. Their devices come back without status. The endpoint also requires `shortIds`: send `true` to get the 32-character room, desk, and device IDs that the other Sync Cloud API endpoints accept.

> [accordion] Logitech limits the request rate
>
> The Sync Cloud API allows at most 14,400 requests a day (about 10 a minute on average), a sustained rate of 1 request a second, and bursts of 10 a second. Workflows that loop over many rooms or devices should pace their calls and retry throttled requests with exponential backoff. `POST /bulk` runs up to 200 requests in one call and counts as a single request. It doesn't accept list requests, device reboots, or device updates, and it returns HTTP 200 even when some items fail, so check the `status` of each item in the result. `projection` on `GET /place` limits the response to the fields you need.

> [accordion] Reboots and software updates finish later
>
> A successful reboot response means the request is queued, not that the device has rebooted. Sync holds it for up to 5 minutes if the device is offline. A software update starts only on devices whose `updateStatus` is `UpdateAvailable`, and a successful response means the request was sent. Track progress with the device's `updateStatus`.

> [accordion] Connecting more than one Sync organization
>
> Each connection serves one Sync organization. To use another organization, add a separate Logitech Sync connection with that organization's Org ID, certificate, and private key.

***

Need help? Contact **[support@serval.com](mailto:support@serval.com)** for assistance with your Logitech Sync integration.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.