generate onboarding url - WattShift Documentation

POST

/

v1

/

onboarding

/

url

/

generate

{
  "url": "<string>",
  "homeId": "<string>"
}

Headers

x-ws-api-key

string

WattShift API Key

Body

application/json

redirectUrl

string

required

enableThirdPartyDevice

boolean

required

hvacs

object[]

required

userId

string

homeId

string

used for resuming or restarting onboarding process for existing home

Response

200 - application/json

url

string

required

onboarding url

homeId

string

required

id of home being onboarded

Introduction generate session token

{
  "url": "<string>",
  "homeId": "<string>"
}