There is a newer webhook service available!
We now provide a newer webhook system with multi-device support where new features and events will be added. See https://rachio.readme.io/reference/webhooks
The following information is still valid but there are no plans to update NotificationService.
Webhook types and subtypes:
Type : DEVICE_STATUS
Subtype:
OFFLINE
ONLINE
OFFLINE_NOTIFICATION
COLD_REBOOT
SLEEP_MODE_ON
SLEEP_MODE_OFF
BROWNOUT_VALVE
RAIN_SENSOR_DETECTION_ON
RAIN_SENSOR_DETECTION_OFF
RAIN_DELAY_ON
RAIN_DELAY_OFF
Type : SCHEDULE_STATUS
Subtype:
SCHEDULE_STARTED
SCHEDULE_STOPPED
SCHEDULE_COMPLETED
WEATHER_INTELLIGENCE_NO_SKIP
WEATHER_INTELLIGENCE_SKIP
WEATHER_INTELLIGENCE_CLIMATE_SKIP
WEATHER_INTELLIGENCE_FREEZE
Type : ZONE_STATUS
Subtype:
ZONE_STARTED
ZONE_STOPPED
ZONE_COMPLETED
ZONE_CYCLING
ZONE_CYCLING_COMPLETED
Type : DEVICE_DELTA
Subtype : DEVICE_DELTA
Type : ZONE_DELTA
Subtype : ZONE_DELTA
Type : SCHEDULE_DELTA
Subtype : SCHEDULE_DELTA
Webhook data
All webhooks follow the same object structure, and will provide different string description of the event.
{
"id": "8c3f5e90-fb30-3425-a95d-11fa31244f66", // ID of the webhook
"summary": "Scheduled waterings will now run on controller Rachio-E1323B.", //Summary of the event
"hidden": false, // Whether the event is hidden to the consumer or not
"externalId": "123221231", // External ID provided by the POST event when you create a webhook
"category": "DEVICE", // Category of the event (device, zone, schedule)
"type": "RAIN_DELAY", // type of event (varies by Hook type)
"subType": "RAIN_DELAY_ON", // description of the type of event
"deviceId": "15c388d3-ca86-4c49-96d1-de11c965988d", // Controller ID
"eventDate": 1520803848658, // date the event happend
"createDate": 1520803848658, // date event was created
"lastUpdateDate": 1520803848658 // date event was updated
}
Sample JSON
OFFLINE
{"routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","mqttTimestamp":1522396503635,"icon":"DEVICE","externalId":"5843","type":"DEVICE_STATUS","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","sequence":75,"pin":"de930c65","subType":"OFFLINE","id":"cc6ddfeb-a2ee-3d0c-8384-3dc1adab16e2","connectId":722,"category":"DEVICE","timestamp":"2018-03-30T06:58:20Z"}
ONLINE
{"routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","mqttTimestamp":1522393105367,"wakeReason":"mqtt_socket","icon":"DEVICE","externalId":"5843","type":"DEVICE_STATUS","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","network":{"gw":"10.1.10.1","rssi":-35,"dns2":"208.67.220.220","dns1":"208.67.222.222","ip":"10.1.10.85","nm":"255.255.255.0"},"sequence":76,"pin":"de930c65","subType":"ONLINE","id":"cc6ddfeb-a2ee-3d0c-8384-3dc1adab16e2","connectId":722,"category":"DEVICE","status":"reconnect","timestamp":"2018-03-30T06:58:20Z"}
RAIN_DELAY_ON
{"summary":"No scheduled waterings will run on controller Rachio-DB6769 until Thursday, March 29 07:18 PM (MDT).","routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","icon":"SCHEDULE","timeZone":"America/Denver","externalId":"5843","eventType":"RAIN_DELAY_EVENT","type":"RAIN_DELAY","title":"Delay Watering ON","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","deviceName":"Rachio-DB6769","dateTimeForSummary":"Thursday, March 29 07:18 PM (MDT)","startTime":"2018-03-29T01:18:25.613Z","subType":"RAIN_DELAY_ON","endTime":"2018-03-30T01:18:24Z","id":"42f76bef-60b1-3b56-b0aa-31251f231794","iconUrl":"https://media.rach.io/v3_dev_event_icons/delay_water","category":"DEVICE","timestamp":"2018-03-29T01:18:25.613Z"}
RAIN_DELAY_OFF
{"summary":"Scheduled waterings will now run on controller Rachio-DB6769.","routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","icon":"SCHEDULE","timeZone":"America/Denver","externalId":"5843","eventType":"RAIN_DELAY_EVENT","type":"RAIN_DELAY","title":"Delay Watering OFF","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","deviceName":"Rachio-DB6769","dateTimeForSummary":"Wednesday, March 28 07:18 PM (MDT)","startTime":"2018-03-29T01:18:59.507Z","subType":"RAIN_DELAY_OFF","endTime":"2018-03-29T01:18:59Z","id":"7b34b766-2a05-3a26-a6cb-298ce377f921","iconUrl":"https://media.rach.io/v3_dev_event_icons/delay_water","category":"DEVICE","timestamp":"2018-03-29T01:18:59.507Z"}
SCHEDULE_STARTED
{"scheduleName":"Quick Run","routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","icon":"SCHEDULE","description":"Quick Run will run for 1 minutes.","endTimeForSummary":"07:20 PM (MDT)","type":"SCHEDULE_STATUS","title":"Schedule Started","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","duration":60,"pushTitle":"Schedule Started","startTime":"2018-03-29T01:19:30.471Z","id":"d8c266fb-a386-3f83-bab0-054aef951ebe","iconUrl":"https://media.rach.io/v3_dev_event_icons/quick_run","timestamp":"2018-03-29T01:19:26Z","summary":"Quick Run will run for 1 minutes.","durationInMinutes":1,"timeZone":"America/Denver","externalId":"5843","timeForSummary":"07:19 PM (MDT)","eventType":"SCHEDULE_STARTED_EVENT","dateForSummary":"3/28","scheduleType":"FIXED","subType":"SCHEDULE_STARTED","endTime":"2018-03-29T01:20:30.471Z","category":"SCHEDULE"}
ZONE_STARTED
{"routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","mqttTimestamp":1522286371462,"icon":"SCHEDULE","endTimeForSummary":"07:20 PM (MDT)","type":"ZONE_STATUS","title":"Zone 1 Started","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","duration":60,"pin":"de930c65","zoneNumber":1,"zoneId":"59191296-962a-4ad3-9f69-ec383634d3b9","zoneCurrent":-6,"correlationId":0,"id":"6fa13ec6-22e0-39c8-b27f-e149ec7d61ff","iconUrl":"https://media.rach.io/v3_dev_event_icons/zone_run","zoneName":"Zone 1","timestamp":"2018-03-29T01:19:26Z","summary":"Zone 1 began watering at 07:19 PM (MDT).","zoneRunState":"STARTED","durationInMinutes":1,"timeZone":"America/Denver","externalId":"5843","timeForSummary":"07:19 PM (MDT)","eventType":"DEVICE_ZONE_RUN_STARTED_EVENT","sequence":19,"flowVolume":0,"zoneRunStatus":{"duration":60,"scheduleType":"FIXED","zoneNumber":1,"corId":0,"executionType":"MANUAL","startTime":"2018-03-29T01:19:30.462Z","state":"STARTED","endTime":"2018-03-29T01:20:30.462Z","seqId":1094,"ix":0},"subType":"ZONE_STARTED","endTime":"2018-03-29T01:20:30.462Z","category":"DEVICE"}
ZONE_COMPLETED
{"routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","mqttTimestamp":1522286428025,"icon":"SCHEDULE","endTimeForSummary":"07:20 PM (MDT)","type":"ZONE_STATUS","title":"Zone 1 Completed","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","duration":60,"pin":"de930c65","zoneNumber":1,"zoneId":"59191296-962a-4ad3-9f69-ec383634d3b9","zoneCurrent":-6,"correlationId":0,"id":"5be98268-7ed9-386c-a515-b13a26f20f12","iconUrl":"https://media.rach.io/v3_dev_event_icons/zone_run","zoneName":"Zone 1","timestamp":"2018-03-29T01:20:26Z","summary":"Zone 1 completed watering at 07:20 PM (MDT) for 1 minutes.","zoneRunState":"COMPLETED","durationInMinutes":1,"timeZone":"America/Denver","externalId":"5843","timeForSummary":"07:19 PM (MDT)","eventType":"DEVICE_ZONE_RUN_COMPLETED_EVENT","sequence":20,"flowVolume":0,"zoneRunStatus":{"duration":60,"scheduleType":"FIXED","zoneNumber":1,"corId":0,"executionType":"MANUAL","startTime":"2018-03-29T01:19:27.025Z","state":"COMPLETED","endTime":"2018-03-29T01:20:27.025Z","seqId":1094,"ix":0},"subType":"ZONE_COMPLETED","endTime":"2018-03-29T01:20:27.025Z","category":"DEVICE"}
SCHEDULE_COMPLETED
{"scheduleName":"Quick Run","routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","icon":"SCHEDULE","description":"Quick Run ran for 1 minutes.","endTimeForSummary":"07:20 PM (MDT)","type":"SCHEDULE_STATUS","title":"Schedule Completed","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","duration":60,"pushTitle":"Schedule Completed","startTime":"2018-03-29T01:19:27.030Z","id":"7e419be3-b590-3b09-99b8-5e9fb603e8da","iconUrl":"https://media.rach.io/v3_dev_event_icons/quick_run","timestamp":"2018-03-29T01:20:26Z","summary":"Quick Run ran for 1 minutes.","durationInMinutes":1,"timeZone":"America/Denver","externalId":"5843","timeForSummary":"07:19 PM (MDT)","eventType":"SCHEDULE_COMPLETED_EVENT","dateForSummary":"3/28","scheduleType":"FIXED","subType":"SCHEDULE_COMPLETED","endTime":"2018-03-29T01:20:27.030Z","category":"SCHEDULE"}
DEVICE_DELTA
{"routingId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","icon":"NO_ICON","action":"UPDATED","externalId":"5843","subType":"DEVICE_DELTA","id":"4412d850-704f-37c6-81e1-5cc1434f8ef6","type":"DELTA","category":"DEVICE","deviceId":"1f9e35cc-f9fe-4615-aac9-2a58371b6cca","timestamp":"2018-04-03T15:06:01.176Z"}