Skip to main content
POST
/
v1
/
devices
/
hvac
/
thermostat_behavior
/
webhook
/
set
set webhook thermostat behavior
curl --request POST \
  --url https://api.example.com/v1/devices/hvac/thermostat_behavior/webhook/set \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "webhookUrl": "https://example.com/wattshift/webhook",
  "securityKey": "your_webhook_security_key"
}
'
{
  "id": "ws_webhook_123456789",
  "createdAt": "2025-01-02T12:00:00.000Z",
  "updatedAt": "2025-01-02T12:00:00.000Z",
  "apiOwnerOrgId": "org_123456789",
  "webhookUrl": "https://example.com/wattshift/webhook",
  "securityKey": "your_webhook_security_key",
  "eventType": "THERMOSTAT_QUERY",
  "lastSentAt": null,
  "openAdr": false
}

Authorizations

x-ws-api-key
string
header
required

Headers

x-ws-api-key
string

WattShift API Key

Body

application/json
webhookUrl
string<uri>
required
securityKey
string
required

This security key will be sent back in the webhook under x-ws-security-key header.

Response

200 - application/json
id
string
required
createdAt
any
required
updatedAt
any
required
apiOwnerOrgId
string
required
webhookUrl
string
required
eventType
enum<string>
required
Available options:
UNKNOWN,
SET_POINT_SCHEDULE,
THERMOSTAT_QUERY,
PRICE_SIGNAL
openAdr
boolean
required
securityKey
string | null
lastSentAt
unknown