Skip to main content
POST
Set or update the price signal webhook for the organization

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