Welcome to the Google Home Developer Center, the new destination for learning how to develop smart home actions. Note: You'll continue building actions in the Actions console.

Method: devices.requestSync

Stay organized with collections Save and categorize content based on your preferences.

Requests Google to send an action.devices.SYNC intent to your smart home Action to update device metadata for the given user.

The third-party user's identity is passed via the agentUserId (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project.

HTTP request

POST https://homegraph.googleapis.com/v1/devices:requestSync

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
  "agentUserId": string,
  "async": boolean


Required. Third-party user ID.



Optional. If set, the request will be added to a queue and a response will be returned immediately. This enables concurrent requests for the given agentUserId, but the caller will not receive any error responses.

Response body

If successful, the response body is empty.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/homegraph

For more information, see the OAuth 2.0 Overview.