Skip to main content

Cloudbeds Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Cloudbeds location.
cloudbeds_api.png

Cloudbeds

Create a Cloudbeds Destination​

  1. Click the + icon on the Nexset that will be sent to the Cloudbeds destination, and select the Send to Destination option from the menu.

  2. Select the Cloudbeds connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Cloudbeds property, and click Next; or, create a new Cloudbeds credential for use in this flow.

  3. In Nexla, Cloudbeds destinations can be created using pre-built endpoint templates, which expedite destination setup for common Cloudbeds endpoints. Each template is designed specifically for the corresponding Cloudbeds endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Cloudbeds destinations can also be configured manually, allowing you to send data to Cloudbeds endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Cloudbeds endpoints. Each template is designed specifically for the corresponding Cloudbeds endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Guest

    Creates a new guest profile at the property. Use this endpoint to push new guest records from an external CRM or booking system into Cloudbeds.

    • Map the Nexset attributes to the guest fields expected by the Cloudbeds postGuest endpoint (such as first name, last name, email, and country).
    • The request is sent as a POST with application/x-www-form-urlencoded content. Ensure the Nexset records contain the fields required by Cloudbeds for guest creation.

    This endpoint requires the write:guest scope on the OAuth credential.

    Update Guest

    Updates an existing guest profile, including contact information, preferences, and document details.

    • Include the guest identifier and the fields to be updated in each Nexset record. The request is sent as a PUT to the putGuest endpoint.

    This endpoint requires the write:guest scope on the OAuth credential.

    Create Reservation

    Creates a new reservation for a guest at the property. Use this endpoint to push bookings from a booking engine, channel manager, or OTA integration into Cloudbeds.

    • Map the Nexset attributes to the reservation fields expected by the Cloudbeds postReservation endpoint, including guest details, room or rate plan IDs, and check-in/check-out dates.
    • Rate plan IDs can be obtained from the List Rate Plans data source endpoint.

    This endpoint requires the write:reservation scope on the OAuth credential.

    Update Reservation

    Updates an existing reservation, including dates, room assignment, status, and notes.

    • Include the reservation identifier and the fields to be updated in each Nexset record. The request is sent as a PUT to the putReservation endpoint.

    Update Reservation Room Status

    Changes the room or stay status of a reservation, such as check-in, check-out, no-show, or cancelled.

    • Include the reservation identifier and the target status in each Nexset record. The request is sent as a PUT to the putReservationRoomStatus endpoint.

    Post Payment

    Posts a payment transaction against a reservation or house account.

    • Map the Nexset attributes to the payment fields expected by the Cloudbeds postPayment endpoint, including the reservation, amount, and payment method.
    • Use the List Payment Methods and Get Payments Capabilities data source endpoints first to confirm the accepted tender types and available payment flows.

    This endpoint requires the write:payment scope on the OAuth credential. Cloudbeds recommends verifying payment capabilities before posting payments.

    Store Credit Card

    Stores a credit card on file for an existing reservation. This endpoint supports pre-authorization, incidental holds, and OTA-imported virtual card workflows.

    • Include the reservation identifier and card details in each Nexset record. The request is sent as a POST to the postCreditCard endpoint.

    Handle stored card data in accordance with PCI requirements and your organization's data security policies.

    Post Housekeeping Log

    Logs a housekeeping status update (such as clean, dirty, or inspected) for a room.

    • Include the room identifier and the housekeeping status in each Nexset record. The request is sent as a POST to the postHousekeepingAssignment endpoint.

    This endpoint requires the write:housekeeping scope on the OAuth credential.

    Update Room Availability

    Updates room availability and inventory, including open/close dates and stop-sell settings. This endpoint is required for channel-manager and yield-management integrations.

    • Include the room or room block identifier and the availability values in each Nexset record. The request is sent as a PUT to the putRoomBlocks endpoint.

    Update Room Rate

    Updates room rates for specific date ranges and rate plans. This endpoint is used by revenue-management and dynamic pricing systems.

    • Include the rate plan identifier, date range, and rate values in each Nexset record. The request is sent as a PUT to the putRate endpoint.
    • Rate plan IDs can be obtained from the List Rate Plans data source endpoint.

    This endpoint requires the write:rate scope on the OAuth credential.

    Update Room Out-of-Order

    Marks a room as Out-of-Order or Out-of-Service to block it from new reservations. This endpoint is used by maintenance and operations workflows.

    • Include the room identifier and the out-of-service details (such as date range and reason) in each Nexset record. The request is sent as a PUT to the putRoomOutOfService endpoint.

    Cancel Reservation (Destructive)

    Cancels a reservation in the PMS. This is a destructive operation that should be used with care.

    • Include the reservation identifier in each Nexset record. Despite the "delete" naming, Cloudbeds exposes this operation as a POST to the deleteReservation endpoint.

    This operation cancels reservations in your live Cloudbeds property. Validate the input data carefully before activating a flow that uses this endpoint.

Configure Manually​

Cloudbeds destinations can be manually configured to send data to any valid Cloudbeds API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Cloudbeds API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Cloudbeds API from the Method pulldown menu. Cloudbeds write endpoints use POST (create operations) and PUT (update operations).

Data Format​

  1. Select the format in which the Nexset data will be sent to the Cloudbeds API from the Content Format pulldown menu. Cloudbeds PMS API v1.2 write endpoints accept application/x-www-form-urlencoded content. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Cloudbeds API endpoint to which you want to send the Nexset data in the URL field. Cloudbeds PMS API v1.2 endpoints use the base https://api.cloudbeds.com/api/v1.2/ (for example, https://api.cloudbeds.com/api/v1.2/postReservation). For update operations, include the relevant object identifier as required by the endpoint.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Cloudbeds destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the Cloudbeds API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the new reservation or guest ID created by Cloudbeds.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Cloudbeds API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Cloudbeds API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Cloudbeds API using the current settings.

    Sending test data to write endpoints will create or modify real records in your Cloudbeds property. Use a non-production property or carefully controlled test data when testing destinations that create, update, or cancel records.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to Cloudbeds, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Cloudbeds until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.