Changelog
Keep track of changes and upgrades to the TIDY API.
Your API version controls the API and webhook behavior you see (for example, what properties you see in responses). The TIDY API uses Semantic Versioning (SemVer) for changes, so there should be no breaking changes unless the API increments by a major version (e.g. 1.0 to 2.0). When using your application, any minor version updates will happen automatically, as we expect no breaking changes. Any major version updates will require you to manually update your application to access the latest major version.
TIDY considers the following changes to be backwards-compatible:
- Adding new API resources.
- Adding new optional request parameters to existing API methods.
- Adding new properties to existing API responses.
- Changing the order of properties in existing API responses.
- Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.
- You can safely assume object IDs we generate will never exceed 255 characters, but you should be able to handle IDs of up to that length.
- Adding new event types.
Your webhook listener should gracefully handle unfamiliar event types.
- Added more types you are able to report Issues for
- General improvements on descriptions and documentation
- Added fields
In this month, we added 2 requested features to webhooks:
- You can now specify the events you wish to be notified on. Prior to this release, all filtering for events needed to be done on the client side. Now, you can specify the events you want to filter by within TIDY, so you will only get the vents you want.
- We have added the ability to specify a webhook as for Slack, with other channels coming soon. This will ensure your webhook is formatted correctly for that channel. MS Teams is coming soon, reach out to your account manager for early access.
This is not a feature directly related to the API, but our new teams and advanced permissions feature is live! If you configure teams, users, or permissions in the console, all changes via the API will act as an admin. But users will be limited to their permissions as set up in the console. We are looking for feedback from customers on what kind of teams or permission related items need to be set up in the API. Please reach out to use to let us know how our API can support your teams and permissions related usecases.
One of our biggest releases yet!
(New) Guest Reservations You can now add "Guest Reservations" via the API. This was very highly requested. This is designed for when you are tracking guests coming and going from your property, and want to schedule jobs around them. For example, someone checking in/out of an Airbnb. If you have automatic booking enabled for the address, then job requests will automatically be made following your settings. Note: Automatic Booking is controlled via the console. Customers who previously created jobs directly via the API may want to consider switching to creating reservations instead.
We now offer the following endpoints for GuestReservation model
- GET /guest-reservations
- POST /guest-reservations
- GET /guest-reservations/{guest_reservation_id}
- DELETE /guest-reservations/{guest_reservation_id}
(New) Issues We have also made major improvements to the Issue model, allowing more endpoints to manage issues (such as damage reports) reported by pros or by your team members.
We now offer the following endpoints for Issue model:
- GET /issues
- POST /issues
- GET /issues/{issue_id}
- DELETE /issues/{issue_id}
- POST /issues/{issue_id}/resolve
Jobs The Job model now returns the url, so applications can redirect their users to the job details page in the TIDY app/console.
- Misc bug fixes with no expected impact on customers using public API.
- Misc bug fixes with no expected impact on customers using public API.
- Issues
- Misc bug fixes with no expected impact on customers using public API.
- Misc bug fixes with no expected impact on customers using public API.
- Misc bug fixes with no expected impact on customers using public API.
- Misc bug fixes with no expected impact on customers using public API.
- Pros
- POST /pros
- ToDoList
- GET /to-do-lists
- Misc bug fixes with no expected impact on customers using public API
- Misc bug fixes with no expected impact on customers using public API.
- Booking Availbilities (BookingTimeSlots model)
- GET /booking-availabilities
- Misc bug fixes with no expected impact on customers using public API.
- Misc bug fixes with no expected impact on customers using public API.
- Address model
- POST /address
- GET /addresses
- GET /addresses/{address_id}
- PUT /addresses/{address_id}
- DELETE /addresses/{address_id}
- Job model
- POST /jobs
- GET /jobs
- GET /jobs/{job_id}
- PUT /jobs/{job_id}
- POST /jobs/{job_id}/cancel
- Misc bug fixes with no expected impact on customers using public API.