Skip to main content
POST
/
v1
/
webhook
/
price_signal
/
set
Set or update the price signal webhook for the organization
curl --request POST \
  --url https://api.example.com/v1/webhook/price_signal/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",
  "openAdr": false
}
'
{
  "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": "PRICE_SIGNAL",
  "lastSentAt": null,
  "openAdr": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.wattshift.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
openAdr
boolean
default:false

When true, each home payload uses OpenADR format instead of the standard price signal response.

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