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
}
'
import requests

url = "https://api.example.com/v1/webhook/price_signal/set"

payload = {
"webhookUrl": "https://example.com/wattshift/webhook",
"securityKey": "your_webhook_security_key",
"openAdr": False
}
headers = {
"x-ws-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-ws-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
webhookUrl: 'https://example.com/wattshift/webhook',
securityKey: 'your_webhook_security_key',
openAdr: false
})
};

fetch('https://api.example.com/v1/webhook/price_signal/set', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/webhook/price_signal/set",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'webhookUrl' => 'https://example.com/wattshift/webhook',
'securityKey' => 'your_webhook_security_key',
'openAdr' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ws-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/webhook/price_signal/set"

payload := strings.NewReader("{\n \"webhookUrl\": \"https://example.com/wattshift/webhook\",\n \"securityKey\": \"your_webhook_security_key\",\n \"openAdr\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-ws-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/webhook/price_signal/set")
.header("x-ws-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"https://example.com/wattshift/webhook\",\n \"securityKey\": \"your_webhook_security_key\",\n \"openAdr\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/webhook/price_signal/set")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"https://example.com/wattshift/webhook\",\n \"securityKey\": \"your_webhook_security_key\",\n \"openAdr\": false\n}"

response = http.request(request)
puts response.read_body
{
  "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
}

Authorizations

x-ws-api-key
string
header
required

WattShift API key

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