How to Connect Your BrightSide Account
BrightSide is a property management system for vacation rentals. Our integration enables BrightSide customers to connect their account and automatically sync their properties, reservations, and Wi-Fi details into Porter.
Benefits of the BrightSide Integration
- Automatic Property Sync: Import the units you have set up in BrightSide as Locations
- Reservations and Guest Info: Reservations are synced along with guest details, so pre-arrival links can be matched to each stay
- Wi-Fi Details: Each unit's Wi-Fi information is synced from BrightSide
- Always Current: Webhooks keep your properties and reservations up to date automatically
- Flexible Property Sync: Choose which BrightSide properties to sync
Step-by-Step Setup Instructions
Part 1: Create an API Key in BrightSide
1. Open the API Keys Page
- Log in to your BrightSide account
- Go to Settings > API Keys (this is the address https://yourcompany.bookonthebrightside.com/settings/api-keys, with your own company name in place of "yourcompany")
2. Create the Key
- Click "+ New API Key"
- Give it a name, such as Porter
3. Grant the Required Permissions
- Check these five scopes:
- units:read
- reservations:read
- guests:read
- wifi:read
- webhooks:manage
Note: BrightSide's dialog explains that grants are additive and that fewer is safer. Porter doesn't need any other scopes, so leave the rest unchecked, including any marked "Upcoming."
4. Copy the Key
- Copy the new API key so you can paste it into Porter in the next part
Part 2: Connect to Your Porter Dashboard
1. Access Integration Settings
- Navigate to your Porter Dashboard
- Select Account from the main menu
- Click on Integrations
2. Add the BrightSide Integration
- Add a new integration under the Property Management section
- Select BrightSide
3. Enter Your Company and API Key
- Company: the first part of your BrightSide address. For yourcompany.bookonthebrightside.com, enter yourcompany
- API Key: paste the key you copied from BrightSide
4. Connect to BrightSide
- Click "Connect to BrightSide"
- Click Test to verify the connection
- Wait for the initial sync to complete
Part 3: Choose Which Properties to Sync
Once your account is connected and the initial sync completes, a "Property sync" section appears in the integration. It controls which BrightSide properties are synced into Porter.
- Open the Property sync section
- Choose which properties to include (by default, all properties are included)
- Click Sync to apply your selection
Part 4: Add Your Pre-Arrival Link to BrightSide Emails
Pre-arrival links let each guest open a personalized page for their stay. To use them, add your permanent pre-arrival link to the email or guest letter BrightSide sends before check-in. BrightSide supports merge fields in its emails and guest letters, which fill in each guest's reservation automatically. See Take Advantage of Pre-Arrival Links for more about how they work.
1. Copy Your Permanent Pre-Arrival Link
- In the Porter Dashboard, open the Location and go to Porters & Links
- Copy the permanent pre-arrival link. With the BrightSide integration, it includes the token [Reservation Id] where the reservation goes
2. Add the Link to Your BrightSide Email
- Open the BrightSide email or guest letter you send before check-in, and paste in the link
- Make sure the reservation part of the link is the [Reservation Id] merge field
Important: Use the [Reservation Id] merge field for the reservation in your link. It's what lets Porter match the link to your synced reservations and personalize it.
3. Test the Link
- Paste your pre-arrival link into a web browser with the literal text [Reservation Id] still in place
- You should see an "It works!" confirmation page, which means the link is set up correctly
What Happens After Setup
✅ Automatic Updates
Once connected, BrightSide keeps Porter current using webhooks:
- Property information stays up to date
- Reservation and guest changes are reflected in Porter
- Wi-Fi details from BrightSide are synced for each unit
Troubleshooting Tips
| Issue | Solution |
|---|---|
| Connection Failed | Check that Company contains only the first part of your BrightSide address (for example "yourcompany"), and that the API Key was copied exactly, with no extra spaces |
| Missing Data or Permission Errors | Confirm your API key has all five scopes: units:read, reservations:read, guests:read, wifi:read, and webhooks:manage |
| Sync Issues | If data isn't appearing, try using the Test or Sync buttons in the integration |
| Missing Properties | Confirm the property is included in your Property sync selection, then click Sync |
| Property List Is Empty | The Property sync section only appears after the integration has synced at least once. Wait for the initial sync to finish, or click Sync |
| Pre-Arrival Link Isn't Personalized | Make sure the link uses the [Reservation Id] merge field |
Need Additional Help?
If you encounter any issues during setup or have questions about the BrightSide integration, please contact our support team (info@tenonedesign.com) with details about your specific situation.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article