Create onboarding guide

Once your integration is complete, we ask that you create an onboarding guide to help hotels understand how to set up and use your integration.

Below is a suggested outline to get you started:

Overview

  • Short introduction of your product
  • What data will be shared between Apaleo and your app?
  • Any prerequisites

How do I connect the app to apaleo?

Configuration

Include information about the following settings:

  • Account settings
  • Property settings or mappings
  • Room mapping
  • Rate mapping
  • Service mapping

Include important notes like, “Only rate plans and services that have ‘Channel manager’ channel configured will be available for the mapping.”

Also, provide an example that shows all the mappings. Include your support information and also FAQs explaining best practices or standard errors.

Provide information about who to contact for sync issues. How to request a full-sync? If possible, provide a synchronization button in your app that allows the hotel to trigger a full-sync themselves.

You can refer to the Detco HRS Channel Connector onboarding guide as an example.

How do I disconnect from apaleo?

  • Instructions for disconnecting your app from Apaleo. You can refer to the Flexkeeping onboarding guide as an example.
  • Request the hotel to contact you before disconnecting the app so you can delete the webhook or ARI subscriptions. Same thing for UI integrations.

How to get support?

  • Your support email address
  • Help center or documentation link