Interventions

Copy linkIntroduction

While some capabilities are inherent to the device, such as a vehicleAPI without an onboard GPS being unable to transmit a location, others can be enabled through user actions. We refer to these actions as interventions in our API and documentation.

Interventions typically involve signing up for first-party user accounts, subscribing to a first-party service, changing settings in the first-party app, or adjusting settings on the device itself.

Copy linkAccessing interventions for connected devices

Interventions appear within the capabilities object for each connected device. Any relevant intervention per capability is listed in the interventionIds array. See the example below for how these id's are displayed.

{
  "id": "8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
  "vendor": "TESLA",
  "capabilities": {
    "chargeState": {
      "isCapable": false,
      "interventionIds": [
        "c8a9fe78-44fd-482a-bebc-ef6047e6c0fe",
      ]
    },
    "information": {
      "isCapable": true,
      "interventionIds": []
    },
    { ... }
  },
  { ... }
}

Copy linkAvailable interventions

Find the list of available interventions below.