{"_id":"541c74e251a68c3b45b9ade9","slug":"getting-started","version":"541c74e251a68c3b45b9ade6","body":"This documentation will allow you to control your Rachio Controllers through a public API. Hopefully this will provide infinite flexibility in building mashups!\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you have any questions or feedback you can get support in our [support forum](http://community.rachio.com/c/support).\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/bcdc90b-Rachio_Sprinkler_Controller_Gen_2_with_Phone_1_2.jpg\",\n        \"Rachio Sprinkler Controller Gen 2 with Phone 1 (2).jpg\",\n        2400,\n        2400,\n        \"#edeeee\"\n      ]\n    }\n  ]\n}\n[/block]","createdAt":"2014-09-19T18:24:34.055Z","githubsync":"","hidden":false,"link_external":false,"link_url":"","api":{"params":[],"results":{"codes":[]},"try":true,"url":"","auth":"never","basic_auth":false,"settings":""},"sync_unique":"","type":"basic","title":"Welcome","updates":["593ded2d1d433b000f10d30f"],"user":"541c74b751a68c3b45b9ade2","__v":11,"project":"541c74e151a68c3b45b9ade3","is_link":false,"order":0,"category":"541c74e251a68c3b45b9ade7","excerpt":"Welcome to the Rachio API documentation. Let's get started!","isReference":false,"next":{"pages":[],"description":""},"parentDoc":null,"childrenPages":[]}

Welcome

Welcome to the Rachio API documentation. Let's get started!

This documentation will allow you to control your Rachio Controllers through a public API. Hopefully this will provide infinite flexibility in building mashups! [block:callout] { "type": "info", "body": "If you have any questions or feedback you can get support in our [support forum](http://community.rachio.com/c/support)." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/bcdc90b-Rachio_Sprinkler_Controller_Gen_2_with_Phone_1_2.jpg", "Rachio Sprinkler Controller Gen 2 with Phone 1 (2).jpg", 2400, 2400, "#edeeee" ] } ] } [/block]
This documentation will allow you to control your Rachio Controllers through a public API. Hopefully this will provide infinite flexibility in building mashups! [block:callout] { "type": "info", "body": "If you have any questions or feedback you can get support in our [support forum](http://community.rachio.com/c/support)." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/bcdc90b-Rachio_Sprinkler_Controller_Gen_2_with_Phone_1_2.jpg", "Rachio Sprinkler Controller Gen 2 with Phone 1 (2).jpg", 2400, 2400, "#edeeee" ] } ] } [/block]
{"_id":"5aa18aed8a1fcb0093840fa2","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"541c74e251a68c3b45b9ade7","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-08T19:11:41.089Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"auth":"never","params":[],"url":""},"isReference":false,"order":1,"body":"Rachio's public API has rate limiting in order to improve server performance for all users. We only allow 1,700 calls per day, which is over 1 call per minute. In general, this limit is only reached by integrations that are polling. \n\nLimits are reset 24 hours after the first call is made to the server\n\nIf you’d like to explore a non-polling method, we do support webhooks. We are willing to work with users to discuss exceptions on rate limiting for specific use cases.\n\nRate limiting is reset at midnight UTC and the response header can be viewed for the following data:\n\nX-RateLimit-Limit – The limit that you cannot surpass in a given amount of time\nX-RateLimit-Remaining – The number of calls you have available until a given reset time stamp, or calculated given some sort of sliding time window.\nX-RateLimit-Reset – The timestamp in UTC formatted to HTTP spec per RFC 1123 for when the limits will be reset.\n\nExample of response header data:\n\nx-ratelimit-limit →1700\nx-ratelimit-remaining →4\nx-ratelimit-reset →2018-03-13T00:00:00Z\n\nWe would love to hear about how you have built integrations on top of our API, send me an email at  franz@rach.io.","excerpt":"Welcome to the Rachio API documentation. Let's get started!","slug":"rate-limiting","type":"basic","title":"Rate Limiting","__v":0,"parentDoc":null,"childrenPages":[]}

Rate Limiting

Welcome to the Rachio API documentation. Let's get started!

Rachio's public API has rate limiting in order to improve server performance for all users. We only allow 1,700 calls per day, which is over 1 call per minute. In general, this limit is only reached by integrations that are polling. Limits are reset 24 hours after the first call is made to the server If you’d like to explore a non-polling method, we do support webhooks. We are willing to work with users to discuss exceptions on rate limiting for specific use cases. Rate limiting is reset at midnight UTC and the response header can be viewed for the following data: X-RateLimit-Limit – The limit that you cannot surpass in a given amount of time X-RateLimit-Remaining – The number of calls you have available until a given reset time stamp, or calculated given some sort of sliding time window. X-RateLimit-Reset – The timestamp in UTC formatted to HTTP spec per RFC 1123 for when the limits will be reset. Example of response header data: x-ratelimit-limit →1700 x-ratelimit-remaining →4 x-ratelimit-reset →2018-03-13T00:00:00Z We would love to hear about how you have built integrations on top of our API, send me an email at franz@rach.io.
Rachio's public API has rate limiting in order to improve server performance for all users. We only allow 1,700 calls per day, which is over 1 call per minute. In general, this limit is only reached by integrations that are polling. Limits are reset 24 hours after the first call is made to the server If you’d like to explore a non-polling method, we do support webhooks. We are willing to work with users to discuss exceptions on rate limiting for specific use cases. Rate limiting is reset at midnight UTC and the response header can be viewed for the following data: X-RateLimit-Limit – The limit that you cannot surpass in a given amount of time X-RateLimit-Remaining – The number of calls you have available until a given reset time stamp, or calculated given some sort of sliding time window. X-RateLimit-Reset – The timestamp in UTC formatted to HTTP spec per RFC 1123 for when the limits will be reset. Example of response header data: x-ratelimit-limit →1700 x-ratelimit-remaining →4 x-ratelimit-reset →2018-03-13T00:00:00Z We would love to hear about how you have built integrations on top of our API, send me an email at franz@rach.io.
{"_id":"542af66f54d88d140075ff5b","is_link":false,"order":2,"title":"Obtaining your API Token","createdAt":"2014-09-30T18:29:03.981Z","hidden":false,"user":"541c74b751a68c3b45b9ade2","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Obtaining Your Authorization Token\"\n}\n[/block]\nAuthentication is done via an OAuth2 token currently provided through the Rachio webapp.\n\nLog onto the [webapp](https://app.rach.io). Click on account settings on the bottom left\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/11b2af4-Screen_Shot_2018-03-08_at_12.14.32_PM.png\",\n        \"Screen Shot 2018-03-08 at 12.14.32 PM.png\",\n        1927,\n        988,\n        \"#f3f3f3\"\n      ]\n    }\n  ]\n}\n[/block]\nThen click on 'Get Api Key'\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9490272-Screen_Shot_2018-03-08_at_12.16.17_PM.png\",\n        \"Screen Shot 2018-03-08 at 12.16.17 PM.png\",\n        1909,\n        978,\n        \"#f3f3f3\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Passing your access token  in an authorization header\"\n}\n[/block]\nThe following examples shows the usage of the *Authorization* header and access token.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET -H \\\"Authorization:Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\\\" https://api.rach.io/1/public/person/24763e8a-4418-11e4-a183-164230d1df6\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","updates":[],"project":"541c74e151a68c3b45b9ade3","slug":"authentication","type":"basic","version":"541c74e251a68c3b45b9ade6","__v":19,"link_url":"","category":"541c74e251a68c3b45b9ade7","excerpt":"","githubsync":"","sync_unique":"","api":{"url":"","auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"settings":""},"isReference":false,"link_external":false,"next":{"description":"","pages":[]},"parentDoc":null,"childrenPages":[]}

Obtaining your API Token


[block:api-header] { "type": "basic", "title": "Obtaining Your Authorization Token" } [/block] Authentication is done via an OAuth2 token currently provided through the Rachio webapp. Log onto the [webapp](https://app.rach.io). Click on account settings on the bottom left [block:image] { "images": [ { "image": [ "https://files.readme.io/11b2af4-Screen_Shot_2018-03-08_at_12.14.32_PM.png", "Screen Shot 2018-03-08 at 12.14.32 PM.png", 1927, 988, "#f3f3f3" ] } ] } [/block] Then click on 'Get Api Key' [block:image] { "images": [ { "image": [ "https://files.readme.io/9490272-Screen_Shot_2018-03-08_at_12.16.17_PM.png", "Screen Shot 2018-03-08 at 12.16.17 PM.png", 1909, 978, "#f3f3f3" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Passing your access token in an authorization header" } [/block] The following examples shows the usage of the *Authorization* header and access token. [block:code] { "codes": [ { "code": "curl -X GET -H \"Authorization:Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/person/24763e8a-4418-11e4-a183-164230d1df6", "language": "curl" } ] } [/block]
[block:api-header] { "type": "basic", "title": "Obtaining Your Authorization Token" } [/block] Authentication is done via an OAuth2 token currently provided through the Rachio webapp. Log onto the [webapp](https://app.rach.io). Click on account settings on the bottom left [block:image] { "images": [ { "image": [ "https://files.readme.io/11b2af4-Screen_Shot_2018-03-08_at_12.14.32_PM.png", "Screen Shot 2018-03-08 at 12.14.32 PM.png", 1927, 988, "#f3f3f3" ] } ] } [/block] Then click on 'Get Api Key' [block:image] { "images": [ { "image": [ "https://files.readme.io/9490272-Screen_Shot_2018-03-08_at_12.16.17_PM.png", "Screen Shot 2018-03-08 at 12.16.17 PM.png", 1909, 978, "#f3f3f3" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Passing your access token in an authorization header" } [/block] The following examples shows the usage of the *Authorization* header and access token. [block:code] { "codes": [ { "code": "curl -X GET -H \"Authorization:Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/person/24763e8a-4418-11e4-a183-164230d1df6", "language": "curl" } ] } [/block]
{"_id":"5aa18cc18a1fcb0093841058","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"541c74e251a68c3b45b9ade7","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-08T19:19:29.830Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Once you have acquired your token, you can grab your Person Id and begin making requests\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v https://api.rach.io/1/public/person/info -H \\\"Authorization: Bearer xxxx-xxx\\\"\",\n      \"language\": \"curl\"\n    },\n    {\n      \"code\": \"\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nYou will then get a response that contains the Person ID to begin the rest of the development process","excerpt":"","slug":"making-your-first-request","type":"basic","title":"Making your first request","__v":0,"parentDoc":null,"childrenPages":[]}

Making your first request


Once you have acquired your token, you can grab your Person Id and begin making requests [block:code] { "codes": [ { "code": "curl -v https://api.rach.io/1/public/person/info -H \"Authorization: Bearer xxxx-xxx\"", "language": "curl" }, { "code": "", "language": "text" } ] } [/block] You will then get a response that contains the Person ID to begin the rest of the development process
Once you have acquired your token, you can grab your Person Id and begin making requests [block:code] { "codes": [ { "code": "curl -v https://api.rach.io/1/public/person/info -H \"Authorization: Bearer xxxx-xxx\"", "language": "curl" }, { "code": "", "language": "text" } ] } [/block] You will then get a response that contains the Person ID to begin the rest of the development process
{"_id":"5aa19067e0890a00860e628f","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"541c74e251a68c3b45b9ade7","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-08T19:35:03.608Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5aa19067e0890a00860e6291","ref":"","in":"header","required":false,"desc":"","default":"your-token","type":"string","name":"Authorization"},{"_id":"5aa19067e0890a00860e6290","ref":"","in":"body","required":false,"desc":"","default":"1231231","type":"string","name":"deviceId"}],"url":"/public/zone","method":"put"},"isReference":false,"order":4,"body":"The Rachio API contains four distinct data objects \n\nPerson\nDevice\n  - Zone\n  - ScheduleRule\n\nThese objects are explained below.\n\nWebhooks are explained in detail in the webhooks section\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Person\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"email\\\" : \\\"testing@test.com\\\",\\n   \\\"id\\\" : \\\"xxxxxx-xxxx-xxxx-xxx-xxxxxxxxx\\\",\\n   \\\"username\\\" : \\\"test\\\",\\n   \\\"devices\\\" : [\\n      {}\\n   ],\\n   \\\"createDate\\\" : 1520380702000,\\n   \\\"deleted\\\" : false,\\n   \\\"fullName\\\" : \\\"Testy McTest\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Device\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\" : \\\"55e57aff-d8a2-4e3b-9836-25cf7f6839e7\\\",\\n  \\\"flexScheduleRules\\\" : [],\\n  \\\"serialNumber\\\" : \\\"VR1231212\\\",\\n  \\\"homeKitCompatible\\\" : false,\\n  \\\"name\\\" : \\\"Rachio-E1323B\\\",\\n  \\\"zones\\\" : [],\\n  \\\"on\\\" : false,\\n  \\\"latitude\\\" : 39.739174,\\n  \\\"longitude\\\" : -105.04316,\\n  \\\"createDate\\\" : 1520381260000,\\n  \\\"status\\\" : \\\"OFFLINE\\\",\\n  \\\"deleted\\\" : false,\\n  \\\"scheduleModeType\\\" : \\\"MANUAL\\\",\\n  \\\"model\\\" : \\\"GENERATION2_8ZONE\\\",\\n  \\\"macAddress\\\" : \\\"80A589E1323B\\\",\\n  \\\"scheduleRules\\\" : []\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Zone\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"zoneNumber\\\" : 4,\\n  \\\"runtime\\\" : 1391,\\n  \\\"id\\\" : \\\"108e23aa-4999-4da2-994a-62aa6e207221\\\",\\n  \\\"rootZoneDepth\\\" : 6,\\n  \\\"efficiency\\\" : 0.8,\\n  \\\"fixedRuntime\\\" : 0,\\n  \\\"imageUrl\\\" : \\\"https://prod-media-photo.rach.io/8107d244-1176-44a4-9a7e-d1de3b803f82\\\",\\n  \\\"scheduleDataModified\\\" : false,\\n  \\\"customShade\\\" : {\\n    \\\"name\\\" : \\\"LOTS_OF_SUN\\\"\\n   },\\n   \\\"depthOfWater\\\" : 0.51,\\n   \\\"managementAllowedDepletion\\\" : 0.5,\\n   \\\"customCrop\\\" : {\\n     \\\"name\\\" : \\\"Cool Season Grass\\\",\\n     \\\"coefficient\\\" : 0.8\\n   },\\n   \\\"saturatedDepthOfWater\\\" : 0.56,\\n   \\\"customSoil\\\" : {\\n     \\\"name\\\" : \\\"LOAM\\\"\\n   },\\n   \\\"customNozzle\\\" : {\\n     \\\"name\\\" : \\\"FIXED_SPRAY_HEAD\\\",\\n     \\\"inchesPerHour\\\" : 1.5\\n   },\\n   \\\"availableWater\\\" : 0.17,\\n   \\\"yardAreaSquareFeet\\\" : 500,\\n   \\\"runtimeNoMultiplier\\\" : 1391,\\n   \\\"maxRuntime\\\" : 10800,\\n   \\\"name\\\" : \\\"Zone 4\\\",\\n   \\\"enabled\\\" : true,\\n   \\\"lastWateredDate\\\" : 1520343540000,\\n   \\\"wateringAdjustmentRuntimes\\\" : {\\n     \\\"3\\\" : 1391,\\n     \\\"1\\\" : 2086,\\n     \\\"5\\\" : 695,\\n     \\\"2\\\" : 1739,\\n     \\\"4\\\" : 1043\\n   }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"ScheduleRule\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"xxxxx-xxxxxx\\\",\\n    \\\"zones\\\": [\\n        {\\n            \\\"zoneId\\\": \\\"xxxxx-xxxxxx\\\",\\n            \\\"duration\\\": 780,\\n            \\\"sortOrder\\\": 1\\n        },\\n        {\\n            \\\"zoneId\\\": \\\"b15ed92d-d171-4730-98f2-e82d9a6aacb0\\\",\\n            \\\"duration\\\": 840,\\n            \\\"sortOrder\\\": 3\\n        },\\n        {\\n            \\\"zoneId\\\": \\\"bf7ed8bd-99af-4598-8857-e71c0d26520a\\\",\\n            \\\"duration\\\": 840,\\n            \\\"sortOrder\\\": 0\\n        },\\n        {\\n            \\\"zoneId\\\": \\\"108e23aa-4999-4da2-994a-62aa6e207221\\\",\\n            \\\"duration\\\": 840,\\n            \\\"sortOrder\\\": 2\\n        },\\n        {\\n            \\\"zoneId\\\": \\\"08b73293-4f42-4105-8a67-48d3ed4c209e\\\",\\n            \\\"duration\\\": 840,\\n            \\\"sortOrder\\\": 5\\n        },\\n        {\\n            \\\"zoneId\\\": \\\"0bf273be-a81d-4e6e-9047-d3e1f703a956\\\",\\n            \\\"duration\\\": 840,\\n            \\\"sortOrder\\\": 4\\n        }\\n    ],\\n    \\\"scheduleJobTypes\\\": [\\n        \\\"ANY\\\"\\n    ],\\n    \\\"operator\\\": \\\"AFTER\\\",\\n    \\\"cycleSoakStatus\\\": \\\"OFF\\\",\\n    \\\"startDate\\\": 1523219613691,\\n    \\\"name\\\": \\\"My Flex Monthly\\\",\\n    \\\"enabled\\\": true,\\n    \\\"startDay\\\": 8,\\n    \\\"startMonth\\\": 3,\\n    \\\"startYear\\\": 2018,\\n    \\\"totalDuration\\\": 4980,\\n    \\\"endDate\\\": -62167404386309,\\n    \\\"etSkip\\\": true,\\n    \\\"externalName\\\": \\\"My Flex Monthly\\\",\\n    \\\"cycleSoak\\\": false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Webhooks\"\n}\n[/block]\nAll webhooks follow the same object structure, and will provide different string description of the event. For more information about how webhooks work, please follow this [link](https://www.programmableweb.com/news/what-are-webhooks-and-how-do-they-enable-real-time-web/2012/01/30) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"8c3f5e90-fb30-3425-a95d-11fa31244f66\\\", // ID of the webhook\\n  \\\"summary\\\": \\\"Scheduled waterings will now run on controller Rachio-E1323B.\\\", //Summary of the event\\n  \\\"hidden\\\": false, // Whether the event is hidden to the consumer or not\\n  \\\"externalId\\\": \\\"123221231\\\", // External ID provided by the POST event when you create a webhook\\n  \\\"category\\\": \\\"DEVICE\\\", // Category of the event (device, zone, schedule)\\n  \\\"type\\\": \\\"RAIN_DELAY\\\", // type of event (varies by Hook type)\\n  \\\"subType\\\": \\\"RAIN_DELAY_ON\\\",  // description of the type of event\\n  \\\"deviceId\\\": \\\"15c388d3-ca86-4c49-96d1-de11c965988d\\\", // Controller ID \\n  \\\"eventDate\\\": 1520803848658, // date the event happend\\n  \\\"createDate\\\": 1520803848658, // date event was created\\n  \\\"lastUpdateDate\\\": 1520803848658 // date event was updated\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nhttps://dash.readme.io/legacy/","excerpt":"","slug":"data-objects","type":"basic","title":"Data Objects","__v":3,"parentDoc":null,"childrenPages":[]}

Data Objects


The Rachio API contains four distinct data objects Person Device - Zone - ScheduleRule These objects are explained below. Webhooks are explained in detail in the webhooks section [block:api-header] { "type": "basic", "title": "Person" } [/block] [block:code] { "codes": [ { "code": "{\n \"email\" : \"testing@test.com\",\n \"id\" : \"xxxxxx-xxxx-xxxx-xxx-xxxxxxxxx\",\n \"username\" : \"test\",\n \"devices\" : [\n {}\n ],\n \"createDate\" : 1520380702000,\n \"deleted\" : false,\n \"fullName\" : \"Testy McTest\"\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Device" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\" : \"55e57aff-d8a2-4e3b-9836-25cf7f6839e7\",\n \"flexScheduleRules\" : [],\n \"serialNumber\" : \"VR1231212\",\n \"homeKitCompatible\" : false,\n \"name\" : \"Rachio-E1323B\",\n \"zones\" : [],\n \"on\" : false,\n \"latitude\" : 39.739174,\n \"longitude\" : -105.04316,\n \"createDate\" : 1520381260000,\n \"status\" : \"OFFLINE\",\n \"deleted\" : false,\n \"scheduleModeType\" : \"MANUAL\",\n \"model\" : \"GENERATION2_8ZONE\",\n \"macAddress\" : \"80A589E1323B\",\n \"scheduleRules\" : []\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Zone" } [/block] [block:code] { "codes": [ { "code": "{\n \"zoneNumber\" : 4,\n \"runtime\" : 1391,\n \"id\" : \"108e23aa-4999-4da2-994a-62aa6e207221\",\n \"rootZoneDepth\" : 6,\n \"efficiency\" : 0.8,\n \"fixedRuntime\" : 0,\n \"imageUrl\" : \"https://prod-media-photo.rach.io/8107d244-1176-44a4-9a7e-d1de3b803f82\",\n \"scheduleDataModified\" : false,\n \"customShade\" : {\n \"name\" : \"LOTS_OF_SUN\"\n },\n \"depthOfWater\" : 0.51,\n \"managementAllowedDepletion\" : 0.5,\n \"customCrop\" : {\n \"name\" : \"Cool Season Grass\",\n \"coefficient\" : 0.8\n },\n \"saturatedDepthOfWater\" : 0.56,\n \"customSoil\" : {\n \"name\" : \"LOAM\"\n },\n \"customNozzle\" : {\n \"name\" : \"FIXED_SPRAY_HEAD\",\n \"inchesPerHour\" : 1.5\n },\n \"availableWater\" : 0.17,\n \"yardAreaSquareFeet\" : 500,\n \"runtimeNoMultiplier\" : 1391,\n \"maxRuntime\" : 10800,\n \"name\" : \"Zone 4\",\n \"enabled\" : true,\n \"lastWateredDate\" : 1520343540000,\n \"wateringAdjustmentRuntimes\" : {\n \"3\" : 1391,\n \"1\" : 2086,\n \"5\" : 695,\n \"2\" : 1739,\n \"4\" : 1043\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "ScheduleRule" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"xxxxx-xxxxxx\",\n \"zones\": [\n {\n \"zoneId\": \"xxxxx-xxxxxx\",\n \"duration\": 780,\n \"sortOrder\": 1\n },\n {\n \"zoneId\": \"b15ed92d-d171-4730-98f2-e82d9a6aacb0\",\n \"duration\": 840,\n \"sortOrder\": 3\n },\n {\n \"zoneId\": \"bf7ed8bd-99af-4598-8857-e71c0d26520a\",\n \"duration\": 840,\n \"sortOrder\": 0\n },\n {\n \"zoneId\": \"108e23aa-4999-4da2-994a-62aa6e207221\",\n \"duration\": 840,\n \"sortOrder\": 2\n },\n {\n \"zoneId\": \"08b73293-4f42-4105-8a67-48d3ed4c209e\",\n \"duration\": 840,\n \"sortOrder\": 5\n },\n {\n \"zoneId\": \"0bf273be-a81d-4e6e-9047-d3e1f703a956\",\n \"duration\": 840,\n \"sortOrder\": 4\n }\n ],\n \"scheduleJobTypes\": [\n \"ANY\"\n ],\n \"operator\": \"AFTER\",\n \"cycleSoakStatus\": \"OFF\",\n \"startDate\": 1523219613691,\n \"name\": \"My Flex Monthly\",\n \"enabled\": true,\n \"startDay\": 8,\n \"startMonth\": 3,\n \"startYear\": 2018,\n \"totalDuration\": 4980,\n \"endDate\": -62167404386309,\n \"etSkip\": true,\n \"externalName\": \"My Flex Monthly\",\n \"cycleSoak\": false\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Webhooks" } [/block] All webhooks follow the same object structure, and will provide different string description of the event. For more information about how webhooks work, please follow this [link](https://www.programmableweb.com/news/what-are-webhooks-and-how-do-they-enable-real-time-web/2012/01/30) [block:code] { "codes": [ { "code": "{\n \"id\": \"8c3f5e90-fb30-3425-a95d-11fa31244f66\", // ID of the webhook\n \"summary\": \"Scheduled waterings will now run on controller Rachio-E1323B.\", //Summary of the event\n \"hidden\": false, // Whether the event is hidden to the consumer or not\n \"externalId\": \"123221231\", // External ID provided by the POST event when you create a webhook\n \"category\": \"DEVICE\", // Category of the event (device, zone, schedule)\n \"type\": \"RAIN_DELAY\", // type of event (varies by Hook type)\n \"subType\": \"RAIN_DELAY_ON\", // description of the type of event\n \"deviceId\": \"15c388d3-ca86-4c49-96d1-de11c965988d\", // Controller ID \n \"eventDate\": 1520803848658, // date the event happend\n \"createDate\": 1520803848658, // date event was created\n \"lastUpdateDate\": 1520803848658 // date event was updated\n}", "language": "json" } ] } [/block] https://dash.readme.io/legacy/
The Rachio API contains four distinct data objects Person Device - Zone - ScheduleRule These objects are explained below. Webhooks are explained in detail in the webhooks section [block:api-header] { "type": "basic", "title": "Person" } [/block] [block:code] { "codes": [ { "code": "{\n \"email\" : \"testing@test.com\",\n \"id\" : \"xxxxxx-xxxx-xxxx-xxx-xxxxxxxxx\",\n \"username\" : \"test\",\n \"devices\" : [\n {}\n ],\n \"createDate\" : 1520380702000,\n \"deleted\" : false,\n \"fullName\" : \"Testy McTest\"\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Device" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\" : \"55e57aff-d8a2-4e3b-9836-25cf7f6839e7\",\n \"flexScheduleRules\" : [],\n \"serialNumber\" : \"VR1231212\",\n \"homeKitCompatible\" : false,\n \"name\" : \"Rachio-E1323B\",\n \"zones\" : [],\n \"on\" : false,\n \"latitude\" : 39.739174,\n \"longitude\" : -105.04316,\n \"createDate\" : 1520381260000,\n \"status\" : \"OFFLINE\",\n \"deleted\" : false,\n \"scheduleModeType\" : \"MANUAL\",\n \"model\" : \"GENERATION2_8ZONE\",\n \"macAddress\" : \"80A589E1323B\",\n \"scheduleRules\" : []\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Zone" } [/block] [block:code] { "codes": [ { "code": "{\n \"zoneNumber\" : 4,\n \"runtime\" : 1391,\n \"id\" : \"108e23aa-4999-4da2-994a-62aa6e207221\",\n \"rootZoneDepth\" : 6,\n \"efficiency\" : 0.8,\n \"fixedRuntime\" : 0,\n \"imageUrl\" : \"https://prod-media-photo.rach.io/8107d244-1176-44a4-9a7e-d1de3b803f82\",\n \"scheduleDataModified\" : false,\n \"customShade\" : {\n \"name\" : \"LOTS_OF_SUN\"\n },\n \"depthOfWater\" : 0.51,\n \"managementAllowedDepletion\" : 0.5,\n \"customCrop\" : {\n \"name\" : \"Cool Season Grass\",\n \"coefficient\" : 0.8\n },\n \"saturatedDepthOfWater\" : 0.56,\n \"customSoil\" : {\n \"name\" : \"LOAM\"\n },\n \"customNozzle\" : {\n \"name\" : \"FIXED_SPRAY_HEAD\",\n \"inchesPerHour\" : 1.5\n },\n \"availableWater\" : 0.17,\n \"yardAreaSquareFeet\" : 500,\n \"runtimeNoMultiplier\" : 1391,\n \"maxRuntime\" : 10800,\n \"name\" : \"Zone 4\",\n \"enabled\" : true,\n \"lastWateredDate\" : 1520343540000,\n \"wateringAdjustmentRuntimes\" : {\n \"3\" : 1391,\n \"1\" : 2086,\n \"5\" : 695,\n \"2\" : 1739,\n \"4\" : 1043\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "ScheduleRule" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"xxxxx-xxxxxx\",\n \"zones\": [\n {\n \"zoneId\": \"xxxxx-xxxxxx\",\n \"duration\": 780,\n \"sortOrder\": 1\n },\n {\n \"zoneId\": \"b15ed92d-d171-4730-98f2-e82d9a6aacb0\",\n \"duration\": 840,\n \"sortOrder\": 3\n },\n {\n \"zoneId\": \"bf7ed8bd-99af-4598-8857-e71c0d26520a\",\n \"duration\": 840,\n \"sortOrder\": 0\n },\n {\n \"zoneId\": \"108e23aa-4999-4da2-994a-62aa6e207221\",\n \"duration\": 840,\n \"sortOrder\": 2\n },\n {\n \"zoneId\": \"08b73293-4f42-4105-8a67-48d3ed4c209e\",\n \"duration\": 840,\n \"sortOrder\": 5\n },\n {\n \"zoneId\": \"0bf273be-a81d-4e6e-9047-d3e1f703a956\",\n \"duration\": 840,\n \"sortOrder\": 4\n }\n ],\n \"scheduleJobTypes\": [\n \"ANY\"\n ],\n \"operator\": \"AFTER\",\n \"cycleSoakStatus\": \"OFF\",\n \"startDate\": 1523219613691,\n \"name\": \"My Flex Monthly\",\n \"enabled\": true,\n \"startDay\": 8,\n \"startMonth\": 3,\n \"startYear\": 2018,\n \"totalDuration\": 4980,\n \"endDate\": -62167404386309,\n \"etSkip\": true,\n \"externalName\": \"My Flex Monthly\",\n \"cycleSoak\": false\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Webhooks" } [/block] All webhooks follow the same object structure, and will provide different string description of the event. For more information about how webhooks work, please follow this [link](https://www.programmableweb.com/news/what-are-webhooks-and-how-do-they-enable-real-time-web/2012/01/30) [block:code] { "codes": [ { "code": "{\n \"id\": \"8c3f5e90-fb30-3425-a95d-11fa31244f66\", // ID of the webhook\n \"summary\": \"Scheduled waterings will now run on controller Rachio-E1323B.\", //Summary of the event\n \"hidden\": false, // Whether the event is hidden to the consumer or not\n \"externalId\": \"123221231\", // External ID provided by the POST event when you create a webhook\n \"category\": \"DEVICE\", // Category of the event (device, zone, schedule)\n \"type\": \"RAIN_DELAY\", // type of event (varies by Hook type)\n \"subType\": \"RAIN_DELAY_ON\", // description of the type of event\n \"deviceId\": \"15c388d3-ca86-4c49-96d1-de11c965988d\", // Controller ID \n \"eventDate\": 1520803848658, // date the event happend\n \"createDate\": 1520803848658, // date event was created\n \"lastUpdateDate\": 1520803848658 // date event was updated\n}", "language": "json" } ] } [/block] https://dash.readme.io/legacy/
{"_id":"5aa195f48a1fcb009384122b","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"541c74e251a68c3b45b9ade7","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-08T19:58:44.127Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"You can grab an API Client in postman and start making requests right away\n\nJust create a new environment and add your token from the web app\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/41ecd5f35652dabe933e)","excerpt":"","slug":"postman","type":"basic","title":"Postman","__v":0,"parentDoc":null,"childrenPages":[]}

Postman


You can grab an API Client in postman and start making requests right away Just create a new environment and add your token from the web app [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/41ecd5f35652dabe933e)
You can grab an API Client in postman and start making requests right away Just create a new environment and add your token from the web app [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/41ecd5f35652dabe933e)
{"_id":"5460458ded133016009b33bb","createdAt":"2014-11-10T04:56:45.988Z","hidden":false,"order":0,"sync_unique":"FindPersonInfo","updates":[],"is_link":false,"project":"541c74e151a68c3b45b9ade3","slug":"publicpersoninfo","type":"get","__v":0,"excerpt":"Retrieve the id for the person entity currently logged in through OAuth.","version":"541c74e251a68c3b45b9ade6","link_url":"","title":"/public/person/info","user":"541c74b751a68c3b45b9ade2","api":{"try":true,"url":"/public/person/info","auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-abc8d5c90350d\" https://api.rach.io/1/public/person/info\n","language":"curl","name":"Example Usage:"}]},"method":"get","params":[],"results":{"codes":[{"code":" HTTP/1.1 200 OK\n {\n   \"id\" : \"c8d10892-fd69-48b3-8743-f111e4392d8a\"\n }\n","language":"json","status":"2XX","name":"Success-Response:"}]}},"body":"","category":"5460458ded133016009b33b8","githubsync":"544eb62ecf9f860800800cfe","parentDoc":null,"childrenPages":[]}

get/public/person/info

Retrieve the id for the person entity currently logged in through OAuth.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5460458ded133016009b33b9","body":"","version":"541c74e251a68c3b45b9ade6","project":"541c74e151a68c3b45b9ade3","slug":"publicpersonid","sync_unique":"FindPersonById","__v":43,"category":"5460458ded133016009b33b8","createdAt":"2014-11-10T04:56:45.951Z","editedParams":true,"editedParams2":true,"type":"get","api":{"method":"get","params":[{"_id":"56b253068e24c10d005f690a","required":true,"desc":"Person's unique id","type":"String","name":"id","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n   {\n     \"id\": \"3c59a593-04b8-42df-91db-758f4fe4a97f\",\n     \"username\": \"franz\",\n     \"fullName\": \"Franz Garsombke\",\n     \"email\": \"franz@rach.io\",\n     \"devices\": [\n       {\n       \"id\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n       \"status\": \"ONLINE\",\n       \"zones\": [\n         {\n         \"id\": \"e02de192-5a2b-4669-95c6-34deea3d23cb\",\n         \"zoneNumber\": 3,\n         \"name\": \"Zone 3\",\n         \"enabled\": false,\n         \"customNozzle\": {\n         \"name\": \"Fixed Spray Head\",\n         \"imageUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/nozzle/fixed_spray.png\",\n         \"category\": \"FIXED_SPRAY_HEAD\",\n         \"inchesPerHour\": 1.4\n         },\n         \"availableWater\": 0.17,\n         \"rootZoneDepth\": 10,\n         \"managementAllowedDepletion\": 0.5,\n         \"efficiency\": 0.6,\n         \"yardAreaSquareFeet\": 1000,\n         \"irrigationAmount\": 0,\n         \"depthOfWater\": 0.85,\n         \"runtime\": 3643\n         },\n         ...\n         ],\n     \"timeZone\": \"America/Denver\",\n     \"latitude\": 39.84634,\n     \"longitude\": -105.3383,\n     \"zip\": \"80403\",\n     \"name\": \"Prototype 7\",\n     \"scheduleRules\": [\n       {\n       \"id\": \"cc9c6e6f-c285-4a7b-9911-ff6065e7ff5b\",\n       \"name\": \"\",\n       \"externalName\": \"unknown\"\n     }\n     \"serialNumber\": \"PROTOTYPE7SN\",\n     \"rainDelayExpirationDate\": 1420027691501,\n     \"rainDelayStartDate\": 1420026367029,\n     \"macAddress\": \"PROTOTYPE7MA\",\n     \"elevation\": 2376.8642578125,\n     \"webhooks\": [],\n     \"paused\": false,\n     \"on\": true,\n     \"flexScheduleRules\": [],\n     \"utcOffset\": -25200000\n     }\n   ],\n   \"enabled\": true\n   }\n","language":"json"}]},"try":true,"url":"/public/person/:id","auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/person/c8d10892-fd69-48b3-8743-f111e4392d8a\n","language":"curl"}]}},"excerpt":"Retrieve the information for a person entity","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"link_url":"","user":"541c74b751a68c3b45b9ade2","is_link":false,"order":1,"title":"/public/person/:id","updates":[],"parentDoc":null,"childrenPages":[]}

get/public/person/:id

Retrieve the information for a person entity

Path Params

id:
required
String
Person's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"546051c3809c100800b234de","api":{"try":true,"url":"/public/device/:id","auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/device/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl","name":"Example Usage:"}]},"method":"get","params":[{"desc":"Device's unique id","type":"String","name":"id","in":"path","_id":"56b253028e24c10d005f68fa","required":true}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n   {\n   \"id\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n   \"status\": \"ONLINE\",\n   \"zones\": [\n     {\n     \"id\": \"e02de192-5a2b-4669-95c6-34deea3d23cb\",\n     \"zoneNumber\": 3,\n     \"name\": \"Zone 3\",\n     \"enabled\": false,\n     \"customNozzle\": {\n     \"name\": \"Fixed Spray Head\",\n     \"imageUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/nozzle/fixed_spray.png\",\n     \"category\": \"FIXED_SPRAY_HEAD\",\n     \"inchesPerHour\": 1.4\n     },\n     \"availableWater\": 0.17,\n     \"rootZoneDepth\": 10,\n     \"managementAllowedDepletion\": 0.5,\n     \"efficiency\": 0.6,\n     \"yardAreaSquareFeet\": 1000,\n     \"irrigationAmount\": 0,\n     \"depthOfWater\": 0.85,\n     \"runtime\": 3643\n     },\n     ...\n     ],\n     \"timeZone\": \"America/Denver\",\n     \"latitude\": 39.84634,\n     \"longitude\": -105.3383,\n     \"zip\": \"80403\",\n     \"name\": \"Prototype 7\",\n     \"scheduleRules\": [\n       {\n       \"id\": \"cc9c6e6f-c285-4a7b-9911-ff6065e7ff5b\",\n       \"name\": \"\",\n       \"externalName\": \"unknown\"\n       }\n   ],\n   \"serialNumber\": \"PROTOTYPE7SN\",\n   \"rainDelayExpirationDate\": 1420027691501,\n   \"rainDelayStartDate\": 1420026367029,\n   \"macAddress\": \"PROTOTYPE7MA\",\n   \"elevation\": 2376.8642578125,\n   \"webhooks\": [],\n   \"paused\": false,\n   \"on\": true,\n   \"flexScheduleRules\": [],\n   \"utcOffset\": -25200000\n   }\n","language":"json"}]}},"createdAt":"2014-11-10T05:48:51.389Z","editedParams2":true,"hidden":false,"version":"541c74e251a68c3b45b9ade6","body":"","githubsync":"544eb62ecf9f860800800cfe","is_link":false,"title":"/public/device/:id","type":"get","updates":[],"excerpt":"Retrieve the information for a device entity","link_url":"","order":0,"sync_unique":"FindDeviceById","user":"541c74b751a68c3b45b9ade2","__v":41,"category":"546051c3809c100800b234dd","editedParams":true,"project":"541c74e151a68c3b45b9ade3","slug":"deviceid","parentDoc":null,"childrenPages":[]}

get/public/device/:id

Retrieve the information for a device entity

Path Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"546d937d0f33a80800f583be","body":"","link_url":"","title":"/public/device/:id/current_schedule","updates":[],"slug":"publicdeviceidcurrent_schedule","sync_unique":"FindCurrentSchedule","__v":25,"category":"546051c3809c100800b234dd","createdAt":"2014-11-20T07:08:45.020Z","editedParams2":true,"order":1,"project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","link_external":false,"type":"get","api":{"try":true,"url":"/public/device/:id/current_schedule","auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/current_schedule\n","language":"curl","name":"Example Usage:"}]},"method":"get","params":[{"desc":"Device's unique id","type":"String","name":"id","in":"path","_id":"56b253018e24c10d005f68f9","required":true}],"results":{"codes":[{"name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n  \"deviceId\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n  \"scheduleId\": \"ba8af494-bc32-4b34-8fa4-27bb00033477\",\n  \"type\": \"MANUAL\",\n  \"status\": \"PROCESSING\",\n  \"startDate\": 1416467043933,\n  \"duration\": 600,\n  \"zoneId\": \"710b5add-4ce1-4d10-9a73-523823c7a82b\",\n  \"zoneStartDate\": 1416467043933,\n  \"zoneDuration\": 600,\n  \"cycleCount\": 1,\n  \"totalCycleCount\": 1,\n  \"cycling\": false,\n  \"durationNoCycle\": 600\n}\n","language":"json","status":"2XX"}]}},"editedParams":true,"excerpt":"Retrieve current schedule running, if any.","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"user":"541c74b751a68c3b45b9ade2","parentDoc":null,"childrenPages":[]}

get/public/device/:id/current_schedule

Retrieve current schedule running, if any.

Path Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"546281788ba5620800710e23","project":"541c74e151a68c3b45b9ade3","sync_unique":"FindDeviceEvents","type":"get","createdAt":"2014-11-11T21:36:56.864Z","excerpt":"Retrieve events for a device entity.","title":"/public/device/:id/event?startTime=:startTime&endTime=:endTime","updates":[],"user":"541c74b751a68c3b45b9ade2","editedParams2":true,"slug":"publicdeviceideventstarttimestarttimeendtimeendtim","category":"546051c3809c100800b234dd","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"__v":30,"api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/event?startTime=1414818000000&endTime=1415739608103\n","language":"curl"}]},"method":"get","params":[{"_id":"56b253028e24c10d005f68fd","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"},{"name":"startTime","in":"path","_id":"56b253028e24c10d005f68fc","required":true,"desc":"Query start time milliseconds unix epoch","type":"Number"},{"_id":"56b253028e24c10d005f68fb","required":true,"desc":"Query end time milliseconds unix epoch","type":"Number","name":"endTime","in":"path"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n [\n {\n   \"id\": \"79af85a5-f040-4f59-9f7e-a6f06a7bb251\",\n   \"deviceId\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n   \"category\": \"SCHEDULE\",\n   \"type\": \"SCHEDULE_STATUS\",\n   \"eventDate\": 1415677805635,\n   \"iconUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/generic-schedule-event.png\",\n   \"summary\": \"Every 3 Days at 5:00 AM with a duration of 6 minutes completed\"\n },\n {\n   \"id\": \"0082c2d6-cb2d-4509-9c18-52fa6f6225d8\",\n   \"deviceId\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n   \"category\": \"SCHEDULE\",\n   \"type\": \"ZONE_STATUS\",\n   \"eventDate\": 1415677800664,\n   \"iconUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/watering-stopped.png\",\n   \"summary\": \"Zone 1 ya completed with a duration of 6 minutes\"\n }\n ]\n","language":"json"}]},"try":true,"url":"/public/device/:id/event?startTime=:startTime&endTime=:endTime"},"editedParams":true,"link_url":"","order":2,"version":"541c74e251a68c3b45b9ade6","body":"","parentDoc":null,"childrenPages":[]}

get/public/device/:id/event?startTime=:startTime&endTime=:endTime

Retrieve events for a device entity.

Path Params

id:
required
String
Device's unique id
startTime:
required
Number
Query start time milliseconds unix epoch
endTime:
required
Number
Query end time milliseconds unix epoch

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"547e4596b3f56708000b8ea4","body":"","slug":"publicdeviceidforecastunitsunits","updates":[],"version":"541c74e251a68c3b45b9ade6","githubsync":"544eb62ecf9f860800800cfe","link_url":"","category":"546051c3809c100800b234dd","createdAt":"2014-12-02T23:04:54.594Z","editedParams2":true,"hidden":false,"link_external":false,"sync_unique":"FindForecast","api":{"method":"get","params":[{"_id":"56b253038e24c10d005f6900","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"path"},{"default":"US","type":"String=\"US\",\"METRIC\"","name":"units","in":"path","_id":"56b253038e24c10d005f68ff","required":false,"desc":"forecast data can be represented as US or METRIC units"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"current\": {\n\"time\": 1417447072,\n\"precipIntensity\": 0,\n\"precipProbability\": 0,\n\"windSpeed\": 0,\n\"humidity\": 0.8,\n\"cloudCover\": 1,\n\"dewPoint\": -9,\n\"weatherType\": \"cloudy\",\n\"unitType\": \"METRIC\",\n\"currentTemperature\": -6,\n\"weatherSummary\": \"Cloudy\",\n\"dailyWeatherType\": \"OBSERVATION\",\n\"prettyTime\": \"2014-12-01T15:17:52Z\"\n},\n\" forecast\": [\n{\n  \"time\": 1417447072,\n  \"precipIntensity\": 0.21,\n  \"precipProbability\": 0.38,\n  \"temperatureMin\": -1,\n  \"temperatureMax\": 5,\n  \"windSpeed\": 18,\n  \"humidity\": 0.52,\n  \"cloudCover\": 0.53,\n  \"dewPoint\": -10,\n  \"weatherType\": \"partly-cloudy-day\",\n  \"unitType\": \"METRIC\",\n  \"weatherSummary\": \"Windy with Isolated Snow Showers\",\n  \"dailyWeatherType\": \"FORECAST\",\n  \"prettyTime\": \"2014-12-01T15:17:52Z\"\n},\n...\n]\n}\n","language":"json"}]},"try":true,"url":"/public/device/:id/forecast?units=:units","auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-ab8d5c90350d\" https://api.rach.io/1/public/device/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/forecast?units=US\n","language":"curl"}]}},"user":"541c74b751a68c3b45b9ade2","excerpt":"Retrieve current and predicted forecast","order":4,"project":"541c74e151a68c3b45b9ade3","title":"/public/device/:id/forecast?units=:units","type":"get","__v":18,"editedParams":true,"parentDoc":null,"childrenPages":[]}

get/public/device/:id/forecast?units=:units

Retrieve current and predicted forecast

Path Params

id:
required
String
Device's unique id
units:
String="US","METRIC"US
forecast data can be represented as US or METRIC units

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5461820a64f4f608003ac927","category":"546051c3809c100800b234dd","createdAt":"2014-11-11T03:27:06.318Z","excerpt":"Stop all watering on device","githubsync":"544eb62ecf9f860800800cfe","link_url":"","project":"541c74e151a68c3b45b9ade3","type":"put","updates":[],"slug":"devicestop_water","editedParams":true,"editedParams2":true,"hidden":false,"is_link":false,"user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","api":{"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json","status":"4XX","name":"Error-Response:"}]},"try":true,"url":"/public/device/stop_water","auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\" }' https://api.rach.io/1/public/device/stop_water\n","language":"curl","name":"Example Usage:"}]},"method":"put","params":[{"desc":"Device's unique id","type":"String","name":"id","in":"body","_id":"56b253038e24c10d005f6903","required":true}]},"body":"","order":5,"sync_unique":"StopWater","title":"/public/device/stop_water","__v":38,"parentDoc":null,"childrenPages":[]}

put/public/device/stop_water

Stop all watering on device

Body Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5461820964f4f608003ac924","api":{"params":[{"_id":"56b253038e24c10d005f6902","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"body"},{"_id":"56b253038e24c10d005f6901","required":true,"desc":"Duration in seconds (Range is 0 - 604800 (7 days) )","type":"Number","name":"duration","in":"body"}],"results":{"codes":[{"name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json","status":"2XX"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/device/rain_delay","auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\", \"duration\" : 86400 }' https://api.rach.io/1/public/device/rain_delay\n","language":"curl"}]},"method":"put"},"version":"541c74e251a68c3b45b9ade6","slug":"devicerain_delay","title":"/public/device/rain_delay","__v":38,"editedParams2":true,"excerpt":"Rain delay device","link_url":"","project":"541c74e151a68c3b45b9ade3","sync_unique":"RainDelay","category":"546051c3809c100800b234dd","createdAt":"2014-11-11T03:27:05.898Z","editedParams":true,"githubsync":"544eb62ecf9f860800800cfe","is_link":false,"user":"541c74b751a68c3b45b9ade2","body":"","hidden":false,"order":6,"type":"put","updates":[],"parentDoc":null,"childrenPages":[]}

put/public/device/rain_delay

Rain delay device

Body Params

id:
required
String
Device's unique id
duration:
required
Number
Duration in seconds (Range is 0 - 604800 (7 days) )

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5470bdf6691dc80800895299","category":"546051c3809c100800b234dd","link_url":"","title":"/public/device/on","updates":[],"user":"541c74b751a68c3b45b9ade2","api":{"params":[{"_id":"56b253018e24c10d005f68f8","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json","status":"2XX"},{"code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json","status":"4XX","name":"Error-Response:"}]},"try":true,"url":"/public/device/on","auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\" }' https://api.rach.io/1/public/device/on\n","language":"curl","name":"Example Usage:"}]},"method":"put"},"editedParams":true,"excerpt":"Turn ON all features of the device (schedules, weather intelligence, water budget, etc.)","link_external":false,"order":7,"slug":"publicdeviceon-1","type":"put","sync_unique":"DeviceOn","project":"541c74e151a68c3b45b9ade3","__v":23,"body":"","createdAt":"2014-11-22T16:46:46.663Z","editedParams2":true,"githubsync":"544eb62ecf9f860800800cfe","hidden":false,"version":"541c74e251a68c3b45b9ade6","parentDoc":null,"childrenPages":[]}

put/public/device/on

Turn ON all features of the device (schedules, weather intelligence, water budget, etc.)

Body Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5470bdf6691dc80800895297","slug":"publicdeviceoff-1","__v":23,"category":"546051c3809c100800b234dd","link_external":false,"api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\" }' https://api.rach.io/1/public/device/off\n","language":"curl","name":"Example Usage:"}]},"method":"put","params":[{"desc":"Device's unique id","type":"String","name":"id","in":"body","_id":"56b253008e24c10d005f68f7","required":true}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"try":true,"url":"/public/device/off"},"editedParams2":true,"link_url":"","version":"541c74e251a68c3b45b9ade6","title":"/public/device/off","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","body":"","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"project":"541c74e151a68c3b45b9ade3","sync_unique":"DeviceOff","createdAt":"2014-11-22T16:46:46.184Z","editedParams":true,"excerpt":"Turn OFF all features of the device (schedules, weather intelligence, water budget, etc.)","order":8,"parentDoc":null,"childrenPages":[]}

put/public/device/off

Turn OFF all features of the device (schedules, weather intelligence, water budget, etc.)

Body Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5b7c7bb3a6bfa600037d827e","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"546051c3809c100800b234dd","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-21T20:53:07.844Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\", \"duration\" : 3600 }' https://api.rach.io/1/public/device/pause_zone_run"}]},"results":{"codes":[{"status":204,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5b7c7bb3a6bfa600037d8280","ref":"","in":"path","required":false,"desc":"Device's unique id","default":"","type":"string","name":"id"},{"_id":"5b7c7bb3a6bfa600037d827f","ref":"","in":"path","required":false,"desc":"Duration in seconds (Range is 0 - 3600 (1 hour) )","default":"","type":"int","name":"duration"}],"url":"/public/device/pause_zone_run"},"isReference":false,"order":999,"body":"","excerpt":"Pause a zone run for device","slug":"publicdevicepause_zone_run","type":"put","title":"/public/device/pause_zone_run","__v":1,"childrenPages":[]}

put/public/device/pause_zone_run

Pause a zone run for device

Path Params

id:
string
Device's unique id
duration:
integer
Duration in seconds (Range is 0 - 3600 (1 hour) )

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5b7c7c25ff4a1e000304cd6b","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"546051c3809c100800b234dd","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-21T20:55:01.785Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"language":"curl","code":"curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\"}' https://api.rach.io/1/public/device/resume_zone_run"}]},"results":{"codes":[{"status":204,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5b7c7c25ff4a1e000304cd6c","ref":"","in":"path","required":false,"desc":"Device's unique id","default":"","type":"string","name":"id"}],"url":"/public/device/resume_zone_run"},"isReference":false,"order":999,"body":"","excerpt":"Resume a zone run for device","slug":"publicdeviceresume_zone_run","type":"put","title":"/public/device/resume_zone_run","__v":0,"childrenPages":[]}

put/public/device/resume_zone_run

Resume a zone run for device

Path Params

id:
string
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55bb86b87313650d00c46ed9","editedParams":true,"editedParams2":true,"excerpt":"Retrieve the information for a zone entity","link_external":false,"sync_unique":"FindZoneById","category":"54605b9ff3a81622001a4318","hidden":false,"project":"541c74e151a68c3b45b9ade3","updates":[],"__v":4,"api":{"method":"get","params":[{"type":"String","name":"id","in":"path","_id":"56b253098e24c10d005f6910","required":true,"desc":"Zone's unique id"}],"results":{"codes":[{"code":" HTTP/1.1 200 OK\n {\n \"id\": \"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\",\n \"zoneNumber\": 3,\n \"name\": \"Zone 3\",\n \"enabled\": false,\n \"customNozzle\": {\n   \"name\": \"Fixed Spray Head\",\n   \"imageUrl\": \"https://s3-us-west-2.amazonaws.com/rachio-api-icons/nozzle/fixed_spray.png\",\n   \"category\": \"FIXED_SPRAY_HEAD\",\n   \"inchesPerHour\": 1.4\n  }\n }\n","language":"json","status":"2XX","name":"Success-Response:"}]},"url":"/public/zone/:id","auth":"required","examples":{"codes":[{"code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/device/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl","name":"Example Usage:"}]}},"createdAt":"2015-07-31T14:31:20.706Z","githubsync":"544eb62ecf9f860800800cfe","link_url":"","title":"/public/zone/:id","body":"","order":0,"slug":"publiczoneid","type":"get","version":"541c74e251a68c3b45b9ade6","parentDoc":null,"childrenPages":[]}

get/public/zone/:id

Retrieve the information for a zone entity

Path Params

id:
required
String
Zone's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"54605b9ff3a81622001a431b","__v":40,"api":{"try":true,"url":"/public/zone/start","auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"d3e99d27-25e4-47dd-b354-1db5a84c99d7\", \"duration\" : 60 }' https://api.rach.io/1/public/zone/start\n","language":"curl","name":"Example Usage:"}]},"method":"put","params":[{"desc":"Zone's unique id","type":"String","name":"id","in":"body","_id":"56b253098e24c10d005f6913","required":true},{"name":"duration","in":"body","_id":"56b253098e24c10d005f6912","required":true,"desc":"Duration in seconds (Range is 0 - 10800 (3 Hours) )","type":"Number"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"language":"json","status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n"}]}},"excerpt":"Start a zone","title":"/public/zone/start","type":"put","updates":[],"user":"541c74b751a68c3b45b9ade2","createdAt":"2014-11-10T06:30:55.339Z","editedParams2":true,"link_url":"","order":1,"slug":"zonestart","version":"541c74e251a68c3b45b9ade6","body":"","editedParams":true,"githubsync":"544eb62ecf9f860800800cfe","hidden":false,"is_link":false,"category":"54605b9ff3a81622001a4318","project":"541c74e151a68c3b45b9ade3","sync_unique":"StartZone","parentDoc":null,"childrenPages":[]}

put/public/zone/start

Start a zone

Body Params

id:
required
String
Zone's unique id
duration:
required
Number
Duration in seconds (Range is 0 - 10800 (3 Hours) )

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"547e459ab3f56708000b8eb3","excerpt":"Start multiple zones","hidden":false,"title":"/public/zone/start_multiple","type":"put","updates":[],"__v":18,"createdAt":"2014-12-02T23:04:58.764Z","editedParams":true,"githubsync":"544eb62ecf9f860800800cfe","order":2,"project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","body":"","category":"54605b9ff3a81622001a4318","link_external":false,"link_url":"","slug":"publiczonestart_multiple","sync_unique":"StartMultipleZone","user":"541c74b751a68c3b45b9ade2","api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"zones\" : [{ \"id\" : \"d8913f51-3af5-41e8-b526-7c2da3646309\", \"duration\" : 10, \"sortOrder\" : 1 }] }' https://api.rach.io/1/public/zone/start_multiple\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253098e24c10d005f6911","required":true,"desc":"Zone's unique id, duration, and sort order","type":"Object[]","name":"zoneRunDurations","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json","status":"4XX"}]},"try":true,"url":"/public/zone/start_multiple"},"editedParams2":true,"parentDoc":null,"childrenPages":[]}

put/public/zone/start_multiple

Start multiple zones

Body Params

zoneRunDurations:
required
Object[]
Zone's unique id, duration, and sort order

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55bb9794a8400c2d00873e9f","type":"get","updates":[],"version":"541c74e251a68c3b45b9ade6","body":"","hidden":false,"link_external":false,"link_url":"","project":"541c74e151a68c3b45b9ade3","__v":3,"title":"/public/schedulerule/:id","excerpt":"Retrieve the information for a scheduleRule entity","order":0,"slug":"publicscheduleruleid","api":{"results":{"codes":[{"name":"Success-Response:","code":" HTTP/1.1 200 OK\n   {\n \"id\": \"f887ce96-3103-4774-9de9-6c66a725de18\",\n \"zones\": [\n {\n \"zoneId\": \"1455bba1-0659-4662-91ff-2c1f1e2e9e01\",\n \"zoneNumber\": 1,\n \"duration\": 300,\n \"sortOrder\": 0\n },\n {\n \"zoneId\": \"4d66d57e-b207-462d-bba1-e7e15d61afd9\",\n \"zoneNumber\": 4,\n \"duration\": 300,\n \"sortOrder\": 3\n },\n {\n \"zoneId\": \"688e07b5-578f-442f-af8c-2b2dcc2dae97\",\n \"zoneNumber\": 5,\n \"duration\": 300,\n \"sortOrder\": 4\n },\n {\n \"zoneId\": \"745c6c55-73be-439f-b856-0b5d2cfcc488\",\n \"zoneNumber\": 3,\n \"duration\": 300,\n \"sortOrder\": 2\n },\n {\n \"zoneId\": \"450199ae-f952-469e-9e10-0be81547109b\",\n \"zoneNumber\": 2,\n \"duration\": 300,\n \"sortOrder\": 1\n }\n ],\n \"scheduleJobTypes\": [\n \"DAY_OF_WEEK_3\"\n ],\n \"summary\": \"Every Wed at 9:05 AM\",\n \"rainDelay\": true,\n \"waterBudget\": false,\n \"cycleSoakStatus\": \"ON\",\n \"startDate\": 1437677593983,\n \"name\": \"Every Wed at 9:05 AM\",\n \"enabled\": true,\n \"totalDuration\": 1500,\n \"weatherIntelligenceSensitivity\": 0.25,\n \"seasonalAdjustment\": 0,\n \"totalDurationNoCycle\": 1500,\n \"cycles\": 1,\n \"externalName\": \"Every Wed at 9:05 AM\",\n \"cycleSoak\": true\n }\n","language":"json","status":"2XX"}]},"url":"/public/schedulerule/:id","auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization:8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/schedulerule/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl"}]},"method":"get","params":[{"in":"path","_id":"56b253078e24c10d005f690b","required":true,"desc":"ScheduleRule's unique id","type":"String","name":"id"}]},"category":"5461820964f4f608003ac922","createdAt":"2015-07-31T15:43:16.778Z","editedParams":true,"sync_unique":"FindScheduleRuleById","editedParams2":true,"githubsync":"544eb62ecf9f860800800cfe","parentDoc":null,"childrenPages":[]}

get/public/schedulerule/:id

Retrieve the information for a scheduleRule entity

Path Params

id:
required
String
ScheduleRule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5461820b64f4f608003ac92a","hidden":false,"order":1,"api":{"try":true,"url":"/public/schedulerule/skip","auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"4eab11bc-b455-472d-86de-14fe8fbcb7f9\"  }' https://api.rach.io/1/public/schedulerule/skip\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253088e24c10d005f690e","required":true,"desc":"Schedule rule's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json","status":"4XX"}]}},"body":"","link_url":"","slug":"scheduleruleskip","title":"/public/schedulerule/skip","type":"put","user":"541c74b751a68c3b45b9ade2","createdAt":"2014-11-11T03:27:07.260Z","githubsync":"544eb62ecf9f860800800cfe","editedParams2":true,"excerpt":"Skip a schedule rule (watering time)","editedParams":true,"is_link":false,"project":"541c74e151a68c3b45b9ade3","sync_unique":"SkipScheduleRule","updates":[],"version":"541c74e251a68c3b45b9ade6","__v":38,"category":"5461820964f4f608003ac922","parentDoc":null,"childrenPages":[]}

put/public/schedulerule/skip

Skip a schedule rule (watering time)

Body Params

id:
required
String
Schedule rule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5461820b64f4f608003ac92c","api":{"params":[{"_id":"56b253088e24c10d005f690f","required":true,"desc":"Schedule rule's unique id","type":"String","name":"id","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 204 No content\n","language":"json"},{"name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json","status":"4XX"}]},"try":true,"url":"/public/schedulerule/start","auth":"never","basic_auth":false,"examples":{"codes":[{"language":"curl","name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"4eab11bc-b455-472d-86de-14fe8fbcb7f9\"  }' https://api.rach.io/1/public/schedulerule/start\n"}]},"method":"put"},"body":"","githubsync":"544eb62ecf9f860800800cfe","hidden":false,"slug":"schedulerulestart","type":"put","version":"541c74e251a68c3b45b9ade6","__v":38,"category":"5461820964f4f608003ac922","order":2,"sync_unique":"StartScheduleRule","createdAt":"2014-11-11T03:27:07.694Z","editedParams":true,"is_link":false,"link_url":"","project":"541c74e151a68c3b45b9ade3","title":"/public/schedulerule/start","editedParams2":true,"excerpt":"Start a schedule rule (watering time)","updates":[],"user":"541c74b751a68c3b45b9ade2","parentDoc":null,"childrenPages":[]}

put/public/schedulerule/start

Start a schedule rule (watering time)

Body Params

id:
required
String
Schedule rule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"54c9ca0669c3390d00033a97","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\" : \"4eab11bc-b455-472d-86de-14fe8fbcb7f9\", \"adjustment\" : .2  }' https://api.rach.io/1/public/schedulerule/seasonal_adjustment\n","language":"curl"}]},"method":"put","params":[{"_id":"56b253078e24c10d005f690d","required":true,"desc":"Schedule rule's unique id","type":"String","name":"id","in":"body"},{"_id":"56b253078e24c10d005f690c","required":true,"desc":"Seasonal adjustment percent from 100% to -100% (valid data range is 1 to -1)","type":"Number","name":"adjustment","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n     {\n       \"createDate\": 1421264613904,\n       \"lastUpdateDate\": 1422398127257,\n       \"id\": \"c0ce64a7-7af5-48ea-966f-6032ea5d3dce\",\n       \"zones\": [\n         {\n           \"zoneId\": \"710b5add-4ce1-4d10-9a73-523823c7a82b\",\n           \"zoneNumber\": 1,\n           \"duration\": 36000,\n           \"sortOrder\": 0\n         }\n       ],\n       \"scheduleJobTypes\": [\n       \"INTERVAL_3\"\n       ],\n       \"startHour\": 13,\n       \"startMinute\": 0,\n       \"endHour\": 0,\n       \"endMinute\": 0,\n       \"operator\": \"START_TIME\",\n       \"summary\": \"Every  3 Days at 1:00 pm\",\n       \"restriction\": false,\n       \"type\": \"MANUAL\",\n       \"sortOrder\": 1,\n       \"rainDelay\": true,\n       \"waterBudget\": true,\n       \"cycleSoakStatus\": \"ON\",\n       \"waterBudgetUpdateDate\": 1421953200628,\n       \"startDate\": 1421218800000,\n       \"name\": \"10 hour test\",\n       \"enabled\": true,\n       \"recalculateDurations\": true,\n       \"startDay\": 14,\n       \"startMonth\": 1,\n       \"startYear\": 2015,\n       \"totalDuration\": 56868,\n       \"weatherIntelligenceSensitivity\": 0.125,\n       \"seasonalAdjustment\": 0.4,\n       \"externalName\": \"10 hour test\"\n     }\n","language":"json"},{"status":"4XX","name":"Error-Response:","code":"Error-Response:\n HTTP/1.1 400 Bad Request\n {\n   \"error\" : \"Missing data\", \"code\" : 301\n }\n","language":"json"}]},"url":"/public/schedulerule/seasonal_adjustment"},"editedParams":true,"editedParams2":true,"link_external":false,"order":3,"project":"541c74e151a68c3b45b9ade3","updates":[],"__v":9,"githubsync":"544eb62ecf9f860800800cfe","sync_unique":"SeasonalAdjustmentScheduleRule","title":"/public/schedulerule/seasonal_adjustment","type":"put","version":"541c74e251a68c3b45b9ade6","category":"5461820964f4f608003ac922","excerpt":"Seasonal adjustment for a schedule rule (watering time). This adjustment amount will be applied to the overall run time of the selected schedule while overriding any current adjustments.","hidden":false,"createdAt":"2015-01-29T05:49:58.930Z","body":"","link_url":"","slug":"publicscheduleruleseasonal_adjustment","parentDoc":null,"childrenPages":[]}

put/public/schedulerule/seasonal_adjustment

Seasonal adjustment for a schedule rule (watering time). This adjustment amount will be applied to the overall run time of the selected schedule while overriding any current adjustments.

Body Params

id:
required
String
Schedule rule's unique id
adjustment:
required
Number
Seasonal adjustment percent from 100% to -100% (valid data range is 1 to -1)

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55bb9791a8400c2d00873e97","editedParams":true,"excerpt":"Retrieve the information for a flexscheduleRule entity","githubsync":"544eb62ecf9f860800800cfe","updates":[],"category":"55bb978ea8400c2d00873e89","editedParams2":true,"link_url":"","version":"541c74e251a68c3b45b9ade6","__v":3,"body":"","createdAt":"2015-07-31T15:43:13.380Z","link_external":false,"slug":"publicflexscheduleruleid","sync_unique":"FindFlexScheduleRuleById","title":"/public/flexschedulerule/:id","api":{"auth":"required","examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization:8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/flexschedulerule/99363e8a-4418-11e4-b184-164230d1df90\n","language":"curl"}]},"method":"get","params":[{"required":true,"desc":"FlexScheduleRule's unique id","type":"String","name":"id","in":"path","_id":"56b253048e24c10d005f6904"}],"results":{"codes":[{"language":"json","status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n \"id\": \"6ede2d28-6823-48c7-8398-82bb07b979e3\",\n \"zones\": [\n {\n \"zoneId\": \"450199ae-f952-469e-9e10-0be81547109b\",\n \"zoneNumber\": 2,\n \"sortOrder\": 1\n },\n {\n \"zoneId\": \"745c6c55-73be-439f-b856-0b5d2cfcc488\",\n \"zoneNumber\": 3,\n \"sortOrder\": 2\n },\n {\n \"zoneId\": \"4d66d57e-b207-462d-bba1-e7e15d61afd9\",\n \"zoneNumber\": 4,\n \"sortOrder\": 3\n },\n {\n \"zoneId\": \"1455bba1-0659-4662-91ff-2c1f1e2e9e01\",\n \"zoneNumber\": 1,\n \"sortOrder\": 0\n },\n {\n \"zoneId\": \"688e07b5-578f-442f-af8c-2b2dcc2dae97\",\n \"zoneNumber\": 5,\n \"sortOrder\": 4\n },\n {\n \"zoneId\": \"91e5c36a-ca18-4118-b288-aba0a8a6fb20\",\n \"zoneNumber\": 6,\n \"sortOrder\": 5\n }\n ],\n \"scheduleJobTypes\": [\n \"ODD\"\n ],\n \"summary\": \"Odd days at 3:30 am\",\n \"cycleSoak\": true,\n \"startDate\": -61662358804000,\n \"name\": \"Flex o' rama\",\n \"enabled\": true,\n \"totalDuration\": 33016,\n \"totalDurationNoCycle\": 33016,\n \"externalName\": \"Flex o' rama\",\n \"type\": \"FLEX\"\n }\n"}]},"url":"/public/flexschedulerule/:id"},"order":0,"project":"541c74e151a68c3b45b9ade3","type":"get","hidden":false,"parentDoc":null,"childrenPages":[]}

get/public/flexschedulerule/:id

Retrieve the information for a flexscheduleRule entity

Path Params

id:
required
String
FlexScheduleRule's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5474213d59fade080004c8fc","slug":"publicnotificationwebhook_event_type","updates":[],"api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/webhook_event_type\n","language":"curl"}]},"method":"get","params":[],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n [\n   {\n     \"id\" : \"5\",\n     \"name\": \"ZONE_ACTION\",\n     \"description\" : \"Event description\",\n     \"type\" : \"WEBHOOK\"\n   }\n ]\n","language":"json"}]},"try":true,"url":"/public/notification/webhook_event_type"},"githubsync":"544eb62ecf9f860800800cfe","link_external":false,"hidden":false,"order":0,"project":"541c74e151a68c3b45b9ade3","sync_unique":"FindNotificationWebhookEventTypes","title":"/public/notification/webhook_event_type","body":"","excerpt":"Retrieve the list of events types that are available to any webhook for subscription","user":"541c74b751a68c3b45b9ade2","link_url":"","type":"get","version":"541c74e251a68c3b45b9ade6","__v":0,"category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:09.911Z","parentDoc":null,"childrenPages":[]}

get/public/notification/webhook_event_type

Retrieve the list of events types that are available to any webhook for subscription

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5474213d59fade080004c8fa","excerpt":"Retrieve all webhooks for a device","order":1,"title":"/public/notification/:deviceId/webhook","__v":19,"api":{"params":[{"_id":"56b253058e24c10d005f6906","required":true,"desc":"Device's unique id","type":"String","name":"id","in":"query"}],"results":{"codes":[{"code":" HTTP/1.1 200 OK\n[\n {\n \"id\": \"7c5e7d3c-c140-4e2e-91a1-a212a518aed1\",\n \"url\": \"https://www.mydomain.com/another_webhook\",\n \"externalId\" : \"external company ID\",\n \"eventTypes\": [\n   {\n   \"name\": \"ZONE_ACTION\",\n   \"description\": \"A zone action has has occurred\"\n   },\n   {\n   \"name\": \"SCHEDULE_ACTION\",\n   \"description\": \"A schedule action has occurred\"\n   }\n  ]\n }\n]\n","language":"json","status":"2XX","name":"Success-Response:"}]},"try":true,"url":"/public/notification/:deviceId/webhook","auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/2a5e7d3c-c140-4e2e-91a1-a212a518adc5/webhook\n","language":"curl"}]},"method":"get"},"body":"","project":"541c74e151a68c3b45b9ade3","type":"get","version":"541c74e251a68c3b45b9ade6","editedParams":true,"link_url":"","editedParams2":true,"githubsync":"544eb62ecf9f860800800cfe","slug":"publicnotificationdeviceidwebhook","link_external":false,"sync_unique":"FindAllWebhooks","updates":[],"user":"541c74b751a68c3b45b9ade2","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:09.427Z","hidden":false,"parentDoc":null,"childrenPages":[]}

get/public/notification/:deviceId/webhook

Retrieve all webhooks for a device

Query Params

id:
required
String
Device's unique id

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55bb86b57313650d00c46ed0","link_external":false,"order":2,"slug":"publicnotificationwebhookid-1","sync_unique":"GetWebhook","type":"get","api":{"results":{"codes":[{"name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"createDate\": 1416877798305,\n\"id\": \"79667c29-bd07-428d-9c29-23e18b023978\",\n\"url\": \"https://www.mydomain.com/another_webhook\",\n\"externalId\" : \"external company ID\",\n\"eventTypes\": [\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 1,\n\"name\": \"SCHEDULE_ACTION\",\n\"description\": \"A schedule action has occurred\",\n\"type\": \"WEBHOOK\"\n},\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 2,\n\"name\": \"ZONE_ACTION\",\n\"description\": \"A zone action has has occurred\",\n\"type\": \"WEBHOOK\"\n}\n]\n}\n","language":"json","status":"2XX"}]},"url":"/public/notification/webhook/:id","auth":"required","examples":{"codes":[{"language":"curl","name":"Example Usage:","code":" curl -X GET -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/webhook/79667c29-bd07-428d-9c29-23e18b023978\n"}]},"method":"get","params":[{"type":"String","name":"id","in":"path","_id":"56b253058e24c10d005f6907","required":true,"desc":"Webhook Id to fetch"}]},"category":"546ec2a0e6147a0800c794c6","excerpt":"Get a webhook","hidden":false,"link_url":"","title":"/public/notification/webhook/:id","updates":[],"body":"","createdAt":"2015-07-31T14:31:17.639Z","editedParams2":true,"project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","__v":4,"editedParams":true,"githubsync":"544eb62ecf9f860800800cfe","parentDoc":null,"childrenPages":[]}

get/public/notification/webhook/:id

Get a webhook

Path Params

id:
required
String
Webhook Id to fetch

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5474208959fade080004c8e2","updates":[],"api":{"params":[{"_id":"56b253068e24c10d005f6909","required":true,"desc":"Webhook for device","type":"Object","name":"webhook","in":"body"}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"createDate\": 1416877798305,\n\"id\": \"79667c29-bd07-428d-9c29-23e18b023978\",\n\"url\": \"https://www.mydomain.com/another_webhook\",\n\"externalId\" : \"external company ID\",\n\"eventTypes\": [\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 1,\n\"name\": \"SCHEDULE_ACTION\",\n\"description\": \"A schedule action has occurred\",\n\"type\": \"WEBHOOK\"\n},\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 2,\n\"name\": \"ZONE_ACTION\",\n\"description\": \"A zone action has has occurred\",\n\"type\": \"WEBHOOK\"\n}\n]\n}\n","language":"json"}]},"try":true,"url":"/public/notification/webhook","auth":"never","basic_auth":false,"examples":{"codes":[{"name":"Example Usage:","code":" curl -X PUT -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{ \"id\":\"79667c29-bd07-428d-9c29-23e18b023978\", \"externalId\" : \"external company ID\", \"url\":\"https://www.mydomain.com/another_webhook_new_url\",\"eventTypes\":[{\"id\":\"1\"},{\"id\":\"2\"}]}' https://api.rach.io/1/public/notification/webhook\n","language":"curl"}]},"method":"put"},"body":"","editedParams2":true,"githubsync":"544eb62ecf9f860800800cfe","hidden":false,"sync_unique":"UpdateWebhook","type":"put","__v":20,"editedParams":true,"link_external":false,"link_url":"","order":3,"project":"541c74e151a68c3b45b9ade3","title":"/public/notification/webhook","excerpt":"Update a webhook","slug":"publicnotificationwebhook-1","user":"541c74b751a68c3b45b9ade2","category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:24:09.271Z","version":"541c74e251a68c3b45b9ade6","parentDoc":null,"childrenPages":[]}

put/public/notification/webhook

Update a webhook

Body Params

webhook:
required
Object
Webhook for device

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5474213e59fade080004c8fd","category":"546ec2a0e6147a0800c794c6","githubsync":"544eb62ecf9f860800800cfe","order":4,"project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhookid","type":"delete","__v":19,"createdAt":"2014-11-25T06:27:10.416Z","editedParams2":true,"updates":[],"user":"541c74b751a68c3b45b9ade2","excerpt":"Remove a webhook","link_external":false,"link_url":"","sync_unique":"RemoveWebhook","title":"/public/notification/webhook/:id","version":"541c74e251a68c3b45b9ade6","api":{"url":"/public/notification/webhook/:id","auth":"never","basic_auth":false,"examples":{"codes":[{"language":"curl","name":"Example Usage:","code":" curl -X DELETE -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" https://api.rach.io/1/public/notification/webhook/79667c29-bd07-428d-9c29-23e18b023978\n"}]},"method":"delete","params":[{"type":"String","name":"id","in":"path","_id":"56b253068e24c10d005f6908","required":true,"desc":"Webhook Id to remove"}],"results":{"codes":[]},"try":true},"body":"","editedParams":true,"hidden":false,"parentDoc":null,"childrenPages":[]}

delete/public/notification/webhook/:id

Remove a webhook

Path Params

id:
required
String
Webhook Id to remove

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"5474213c59fade080004c8f8","editedParams2":true,"order":5,"version":"541c74e251a68c3b45b9ade6","__v":19,"body":"","sync_unique":"AddWebhook","title":"/public/notification/webhook","githubsync":"544eb62ecf9f860800800cfe","link_external":false,"link_url":"","type":"post","updates":[],"api":{"auth":"never","basic_auth":false,"examples":{"codes":[{"code":" curl -X POST -H \"Content-Type: application/json\" -H \"Authorization: Bearer 8e600a4c-0027-4a9a-9bda-dc8d5c90350d\" -d '{\"device\":{\"id\":\"2a5e7d3c-c140-4e2e-91a1-a212a518adc5\"}, \"externalId\" : \"external company ID\", \"url\":\"https://www.mydomain.com/another_webhook\",\"eventTypes\":[{\"id\":\"1\"},{\"id\":\"2\"}]}' https://api.rach.io/1/public/notification/webhook\n","language":"curl","name":"Example Usage:"}]},"method":"post","params":[{"desc":"Webhook for device","type":"Object","name":"webhook","in":"body","_id":"56b253048e24c10d005f6905","required":true}],"results":{"codes":[{"status":"2XX","name":"Success-Response:","code":" HTTP/1.1 200 OK\n{\n\"createDate\": 1416877798305,\n\"id\": \"79667c29-bd07-428d-9c29-23e18b023978\",\n\"url\": \"https://www.mydomain.com/another_webhook\",\n\"externalId\" : \"external company ID\",\n\"eventTypes\": [\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 1,\n\"name\": \"SCHEDULE_ACTION\",\n\"description\": \"A schedule action has occurred\",\n\"type\": \"WEBHOOK\"\n},\n{\n\"createDate\": 1416544265115,\n\"lastUpdateDate\": 1416544265115,\n\"id\": 2,\n\"name\": \"ZONE_ACTION\",\n\"description\": \"A zone action has has occurred\",\n\"type\": \"WEBHOOK\"\n}\n]\n}\n","language":"json"}]},"try":true,"url":"/public/notification/webhook"},"category":"546ec2a0e6147a0800c794c6","createdAt":"2014-11-25T06:27:08.927Z","project":"541c74e151a68c3b45b9ade3","slug":"publicnotificationwebhook","user":"541c74b751a68c3b45b9ade2","editedParams":true,"excerpt":"Add a webhook to a device. externalId can be used as opaque data that is tied to your company, and passed back in each webhook event response","hidden":false,"parentDoc":null,"childrenPages":[]}

post/public/notification/webhook

Add a webhook to a device. externalId can be used as opaque data that is tied to your company, and passed back in each webhook event response

Body Params

webhook:
required
Object
Webhook for device

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5ac39a4f77227b0012a39465","project":"541c74e151a68c3b45b9ade3","version":"541c74e251a68c3b45b9ade6","category":"546ec2a0e6147a0800c794c6","user":"541c74b751a68c3b45b9ade2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-03T15:14:23.666Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"## Webhook types and subtypes:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Type : DEVICE_STATUS\\n\\nSubtype:\\n\\nOFFLINE\\nONLINE\\nOFFLINE_NOTIFICATION\\nCOLD_REBOOT\\nSLEEP_MODE_ON\\nSLEEP_MODE_OFF\\nBROWNOUT_VALVE\\nRAIN_SENSOR_DETECTION_ON\\nRAIN_SENSOR_DETECTION_OFF\\nRAIN_DELAY_ON\\nRAIN_DELAY_OFF\\n\\nType : SCHEDULE_STATUS\\n\\nSubtype:\\n\\nSCHEDULE_STARTED\\nSCHEDULE_STOPPED\\nSCHEDULE_COMPLETED\\nWEATHER_INTELLIGENCE_NO_SKIP\\nWEATHER_INTELLIGENCE_SKIP\\nWEATHER_INTELLIGENCE_CLIMATE_SKIP\\nWEATHER_INTELLIGENCE_FREEZE\\n\\nType : ZONE_STATUS\\n\\nSubtype:\\n\\nZONE_STARTED\\nZONE_STOPPED\\nZONE_COMPLETED\\nZONE_CYCLING\\nZONE_CYCLING_COMPLETED\\n\\nType : DEVICE_DELTA\\nSubtype : DEVICE_DELTA\\n\\nType : ZONE_DELTA\\nSubtype : ZONE_DELTA\\n\\nType : SCHEDULE_DELTA\\nSubtype : SCHEDULE_DELTA\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n## Sample JSON\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"OFFLINE\\n\\n{\\\"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\\\"}\\n\\nONLINE\\n\\n{\\\"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\\\"}\\n\\nRAIN_DELAY_ON\\n\\n{\\\"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\\\"}\\n\\nRAIN_DELAY_OFF\\n\\n{\\\"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\\\"}\\n\\nSCHEDULE_STARTED\\n\\n{\\\"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\\\"}\\n\\nZONE_STARTED\\n\\n{\\\"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\\\"}\\n\\nZONE_COMPLETED\\n\\n{\\\"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\\\"}\\n\\n\\nSCHEDULE_COMPLETED\\n\\n{\\\"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\\\"}\\n\\n\\nDEVICE_DELTA\\n\\n{\\\"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\\\"}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"sample-webhook-json","type":"basic","title":"Webhook types and sample JSON","__v":0,"childrenPages":[]}

Webhook types and sample JSON


## Webhook types and subtypes: [block:code] { "codes": [ { "code": "Type : DEVICE_STATUS\n\nSubtype:\n\nOFFLINE\nONLINE\nOFFLINE_NOTIFICATION\nCOLD_REBOOT\nSLEEP_MODE_ON\nSLEEP_MODE_OFF\nBROWNOUT_VALVE\nRAIN_SENSOR_DETECTION_ON\nRAIN_SENSOR_DETECTION_OFF\nRAIN_DELAY_ON\nRAIN_DELAY_OFF\n\nType : SCHEDULE_STATUS\n\nSubtype:\n\nSCHEDULE_STARTED\nSCHEDULE_STOPPED\nSCHEDULE_COMPLETED\nWEATHER_INTELLIGENCE_NO_SKIP\nWEATHER_INTELLIGENCE_SKIP\nWEATHER_INTELLIGENCE_CLIMATE_SKIP\nWEATHER_INTELLIGENCE_FREEZE\n\nType : ZONE_STATUS\n\nSubtype:\n\nZONE_STARTED\nZONE_STOPPED\nZONE_COMPLETED\nZONE_CYCLING\nZONE_CYCLING_COMPLETED\n\nType : DEVICE_DELTA\nSubtype : DEVICE_DELTA\n\nType : ZONE_DELTA\nSubtype : ZONE_DELTA\n\nType : SCHEDULE_DELTA\nSubtype : SCHEDULE_DELTA", "language": "text" } ] } [/block] ## Sample JSON [block:code] { "codes": [ { "code": "OFFLINE\n\n{\"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\"}\n\nONLINE\n\n{\"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\"}\n\nRAIN_DELAY_ON\n\n{\"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\"}\n\nRAIN_DELAY_OFF\n\n{\"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\"}\n\nSCHEDULE_STARTED\n\n{\"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\"}\n\nZONE_STARTED\n\n{\"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\"}\n\nZONE_COMPLETED\n\n{\"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\"}\n\n\nSCHEDULE_COMPLETED\n\n{\"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\"}\n\n\nDEVICE_DELTA\n\n{\"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\"}", "language": "json" } ] } [/block]
## Webhook types and subtypes: [block:code] { "codes": [ { "code": "Type : DEVICE_STATUS\n\nSubtype:\n\nOFFLINE\nONLINE\nOFFLINE_NOTIFICATION\nCOLD_REBOOT\nSLEEP_MODE_ON\nSLEEP_MODE_OFF\nBROWNOUT_VALVE\nRAIN_SENSOR_DETECTION_ON\nRAIN_SENSOR_DETECTION_OFF\nRAIN_DELAY_ON\nRAIN_DELAY_OFF\n\nType : SCHEDULE_STATUS\n\nSubtype:\n\nSCHEDULE_STARTED\nSCHEDULE_STOPPED\nSCHEDULE_COMPLETED\nWEATHER_INTELLIGENCE_NO_SKIP\nWEATHER_INTELLIGENCE_SKIP\nWEATHER_INTELLIGENCE_CLIMATE_SKIP\nWEATHER_INTELLIGENCE_FREEZE\n\nType : ZONE_STATUS\n\nSubtype:\n\nZONE_STARTED\nZONE_STOPPED\nZONE_COMPLETED\nZONE_CYCLING\nZONE_CYCLING_COMPLETED\n\nType : DEVICE_DELTA\nSubtype : DEVICE_DELTA\n\nType : ZONE_DELTA\nSubtype : ZONE_DELTA\n\nType : SCHEDULE_DELTA\nSubtype : SCHEDULE_DELTA", "language": "text" } ] } [/block] ## Sample JSON [block:code] { "codes": [ { "code": "OFFLINE\n\n{\"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\"}\n\nONLINE\n\n{\"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\"}\n\nRAIN_DELAY_ON\n\n{\"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\"}\n\nRAIN_DELAY_OFF\n\n{\"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\"}\n\nSCHEDULE_STARTED\n\n{\"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\"}\n\nZONE_STARTED\n\n{\"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\"}\n\nZONE_COMPLETED\n\n{\"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\"}\n\n\nSCHEDULE_COMPLETED\n\n{\"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\"}\n\n\nDEVICE_DELTA\n\n{\"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\"}", "language": "json" } ] } [/block]
{"_id":"545feeb91604950800a0144c","hidden":false,"slug":"forum","__v":1,"category":"545fee705884720800d64f95","project":"541c74e151a68c3b45b9ade3","title":"Forum","updates":[],"createdAt":"2014-11-09T22:46:17.678Z","link_external":false,"link_url":"","order":0,"type":"basic","api":{"auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":""},"excerpt":"","githubsync":"","is_link":false,"sync_unique":"","user":"541c74b751a68c3b45b9ade2","version":"541c74e251a68c3b45b9ade6","body":"If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).","parentDoc":null,"childrenPages":[]}

Forum


If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).
If you have any questions or feedback you can get support in our [public API support forum](http://community.rachio.com/c/public-api).