Multi Island Third Announcement to API Partners - Action Required

Dear Partner,

We’re excited to follow up on our message at the beginning of the year about Multi Island and API improvements. The number of properties using new islands is growing and we wanted to take this time to make sure you have what you need to support our shared customers.

We have 3 calls to action for you:

1. Update your application to use Cloudbeds API v1.2.

2. Create a test property in a new island so you can easily test your application with longer IDs.

3. Reach out to our development team with any questions on Stack Overflow, tagging your questions with “cloudbeds”, to get answers quickly.

Update your application to use Cloudbeds API v1.2.

Version 1.2 contains important changes to help make it easy to ensure your application is compatible with the IDs in new islands that are bigger than 32 bit integers. It works in all islands and is ready today for you to begin using.

We’ve worked to make this as painless as possible by not introducing changes to the API structure or model, changing only the data types for our IDs from integers to strings. This is a breaking change for your application as we have changed the data type for some parameters and we expect you will have to make some minor changes to adapt and test your code to use strings instead of integers for the IDs.

In addition to changes to calls your application makes to Cloudbeds, we’ve also updated the webhooks that Cloudbeds uses to notify your application. Each webhook payload has new fields with the suffix “_str” that includes the ID as a string value. For example most webhook payloads include “propertyID” which is an integer, they now also include “propertyID_str” which is the same value as a string. You should update your code to use the _str versions of these values going forward. Our Webhooks documentation includes the full list of events and their payloads where you can see the new _str properties added for easy reference.

Create a test property in a new island

You can create a new property in one of our new islands to use to connect to your application, allowing you to test scenarios where an ID longer than a 32 bit integer will be used.

Go to https://www.cloudbeds.com/trial-account/ to begin the process. Fill in the required fields with sample data appropriate for your application but take note that you do need access to the email address you provide to complete the creation process.

At the end of the form you need to select “Yes” to the question “Does this property belong to a group?” to enable you to select the island to use. You should select “US2” as the Island Location. An example with the correct values selected is shown below:

Once you have created your test property, you can go to the Marketplace and connect to your application for further testing.

Reach out to our development team with any questions on Stack Overflow

Our engineering team uses Stack Overflow when they have questions with their work and we suspect your team may as well. We’re excited to announce that we’ve begun using Stack Overflow to bring our engineering team closer to yours and share information more easily between them. Tag questions with “cloudbeds” and we’ll do our best to answer your questions quickly and completely. Additionally you can benefit from the questions others have asked - if you have a question you’re probably not alone.

We welcome any questions or suggestions you may have regarding these changes, so please don’t hesitate to reach out to us at [email protected].

Thank you,

The Cloudbeds integrations team