Getting Started
Shift Watts!
Responding to Optimized Schedules
After onboarding a user, WattShift will regularly send optimized set-point schedules.
Updating the device behavior accordingly will generate grid revenue, lower customer electric bills, and reduce partner companies’ scope 3 emissions!
Configuring Webhooks
Configure your webhook url with the following endpoint in order to receive updates.
await wattshiftApiCall(`/devices/hvac/set_point_schedule/webhook/set`, {
webhookUrl: "https://your-webhook-url.com",
});
During development, rather than having to wait, you can also query the following endpoint to receive the data for the most recently sent webhook.
const schedules = await wattshiftApiCall(
`/devices/hvac/${hvac.id}/set_point_schedule/get`
);
See: /devices/hvac/:id/set_point_schedule/get
Or you can trigger the webhook manually.
See: /webhook/trigger
Here is an example output from a webhook.
{
eventType: 'SET_POINT_SCHEDULE',
data: {
'ws_device_123efg': {
blocks: [
{
startDatetime: '2024-08-03T12:00:00.000Z',
endDatetime: '2024-08-04T00:00:00.000Z',
targetTemp: '70',
targetMode: 'AUTO', // AUTO, HEAT, COOL
},
{
startDatetime: '2024-08-04T00:00:00.000Z',
endDatetime: '2024-08-04T12:00:00.000Z',
targetTemp: '68',
targetMode: 'COOL',
},
],
startDatetime: '2024-08-03T12:00:00.000Z',
endDatetime: '2024-08-04T12:00:00.000Z',
tempUnits: 'F', // F, C
},
},
}