Skip to main content
POST
/
v1
/
config_flow
/
start
Start a Config Flow
curl --request POST \
  --url http://0.0.0.0:3000/v1/config_flow/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "handler": "tuya"
}
'
{
  "type": "form",
  "flowId": "flow_abc123",
  "handler": "tuya",
  "stepId": "user",
  "data_schema": [
    {
      "name": "region",
      "type": "string"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
handler
string
required

Nome da integração (ex: tuya, mqtt, knx)

Example:

"tuya"

Response

Config flow started

​
type
string

Tipo do passo atual (ex: form, external, abort, create_entry)

​
flowId
string
​
handler
string
​
stepId
string
​
errors
object
​
data_schema
any[] | null
​
url
string | null

URL OAuth2 para redirecionamento externo