Subscribe to a connected vehicle
After creating a connected vehicle, it's advised to open a GraphQL subscription. Whenever making changes such as finishing the authorization or renaming the vehicle, updates are sent over this subscription.
Subscription
The subscription service needs to be initiated with the id of a connected vehicle. After the subscription is established, updates will be provided until the connection is closed.
Arguments
id • non_null • ID
Frequently used fields
status • non_null • ConnectedVehicleStatus
Status of the connected vehicle
label • scalar • String
Custom label for a connected vehicle that can be assigned by a user
Other fields
id • non_null • ID
Unique ID of the connected vehicle
vehicle_id • non_null • ID
Unique ID of the vehicle
provider • non_null • CarConnectivityProvider
Connectivity provider
scope • list • ConnectScope
Scope for accessing the vehicle
vin • scalar • String
Vehicle identification number, unique identifier for a vehicle
Response
A response can either contain a data or an
errors object. The response header will always return
200 as a status code.
Data object
When successful, a data object will be returned with the
requested fields. If there are no fields present the
data object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors object will be returned with
more details in the extensions object. The error object
can contain any of the following objects.
AUTH_TOKEN_EXPIRED
The token you provided is expired
AUTH_TOKEN_INVALID
The token you provided is invalid
CONNECTED_VEHICLE_NOT_FOUND
The connected vehicle was not found