How To: Link Your Aruvo Account to StayNTouch
🧾Summary
This article details the steps to link your StayNTouch account to Aruvo.
🕐 When to Use This Guide
Follow the steps in this article when:
- You've configured your Aruvo account and added at least one property listing
- You need to connect your StayNTouch PMS account to Aruvo.
✅ Before You Begin
Ensure you have the following ready to ensure an easy setup:
- Aruvo account - If you have not set up your account yet, follow the steps in this article to create and configure your account.
- Configure your branding and theme - If you have not completed these steps during initial account setup, follow the steps in this guide to configure your theme and branding.
⚙️ Step-by-Step Setup
1. Open the web portal to Aruvo TV
If you have not created your Aruvo account yet, follow the steps to get started at How To: Create your Aruvo TV account.
2. Navigate to the "Integrations" tab
Click to select the "Integrations" option from the left-side menu.
3. Select the PMS StayNTouch
Click the button to select the "StayNTouch" option from the list.
4. Integration Setup: You must provide the following information to finish your StayNTouch integration.
Tip: Note that this does not need to match your StayNTouch or Aruvo account names. Any display name that helps identify the integration at a glance will be perfect!
- Integration Name (For display purposes only)
- Client ID
- Client Secret (How to get StayNTouch Client Secret)
Step 1. Obtain Client Credentials (Client ID & Client Secret) :
The(hotel/property manager) must initiate this step to gain unrestricted access to the StayNTouch APIs for integration:
- Contact StayNTouch: Send an email to onboarding@stayntouch.com or contact your assigned Client Service Manager.
- Request Credentials: Clearly request the Client ID and Client Secret for the account to enable integration with Aruvo.
- Authorize Data Access: In the same communication, you must explicitly mention that StayNTouch should authorize Aruvo to access the Reservation and Guest data.
Note: These credentials are used to retrieve an access token for API interactions
Step 2: Webhook Configuration:
After adding the Aruvo/Lynx integration, the unique webhook URL from Aruvo must be added to the StayNTouch PMS to transmit real-time updates.
- Retrieve Aruvo Webhook URL: The webhook URL (e.g., https://api.getlynx.co/ProdV1.1/webhook/stayntouch/20132/1220) is automatically generated within the Aruvo/Lynx platform for the respective integration account.
-
Configure in StayNTouch: Instruct StayNTouch (or follow the steps: Navigate to Settings > Chain > Webhooks) to configure the webhook using the following list of required events:
- create_reservation
- edit_reservation
- cancel_reservation
- checkin_completed
- checkedout
- room_assignment_succeed
- reverse_checkout
- reinstate
- no_show
- room_move
- create_guest
- edit_guest
5. Buttons & Behaviors
- "Link PMS": Remains disabled until all fields are filled with valid formats. On click, it sends credentials for validation. If successful, moves to Step 2: Import Units.
- "Cancel": Cancels the process and returns to the PMS selection screen.
6. Intermediate Confirmation Screen (Post-Linking):
- Displays after successful linking, validating the PMS connection.
- Shows StayNTouch icon and name.
7. Host Choices:
- "Import Units from PMS": Proceeds to the Unit Import page and triggers the backend to fetch units and reservations.
- "Close": Skips unit import for now. PMS credentials are saved, and the user is redirected to the dashboard.
8. Success Message: You did it! The "StayNTouch" account is now linked.
9. Prompt Text: Would you like to pull your units from StayNTouch now?
10. Step Progress Indicator:
- Step 1: LINK PMS → Marked as completed with a tick icon.
- Step 2: IMPORT UNIT(S) → Shown as the upcoming step.
🛠️ Troubleshooting Errors When Linking to StayNTouch
Invalid Credentials Error: Confirm you copied all credential details correctly from StayNTouch.”
Incorrect Client ID, Client Secret: Validate these values in your StayNTouch configuration.
🛠️ Manage StayNTouch PMS Integration
Edit Integration Name
Follow the steps below to update the display name of a PMS integration:
- Navigate to the Integrations Page in Aruvo
- Locate the integration to be updated, and click the "Edit" button next to the integration name
- Enter the new display name in the "Integration Name" field, and click the "Save" button when finished.
Note: An integration's display name can be up to 100 characters.
Delete Integration
If needed, you can delete a PMS integration by following the steps below.
Important: Deleting a PMS integration is an irreversible action that results in the permanent loss of data. Aruvo strongly recommends not deleting an integration unless you are certain you no longer need it or its associated data.
- Navigate to the Integrations Page in Aruvo
- Locate the integration to be updated, and click the "Delete" button next to the integration name
- The system will pop up a warning message, noting that deleting the integration will stop the sync between Aruvo and StayNTouch. Follow the steps to proceed with deletion.
- Click the check box to acknowledge "I understand that this action cannot be reversed".
- Type the word "Delete" into the provided field.
- Click "Delete Integration" to confirm and delete.
- The system will update with a success message after deletion is completed. Click the "OK" button to acknowledge and close the window.
Comments
0 comments
Article is closed for comments.