Overview
This article walks through the required steps to connect HappyCo to Entrata. For an overview of what the integration does and what data syncs between the two systems, see the Entrata Integration Overview →.
Prerequisites
- An Entrata administrator with access to Apps > API Access
- A HappyCo account with Administrator access
How to Set it Up
Steps 1 and 2 are completed by your Entrata administrator. Once complete, share the information from Step 3 with your HappyCo contact to finish the setup.
Step 1: Grant HappyCo Access in Entrata
In Entrata, navigate to Apps > API Access and find the HappyCo application. Grant it access to the following API endpoints:
View required API endpoints
| Web Service | Endpoint | Needed For |
|---|---|---|
| Property Units | getMitsPropertyUnits | Base Integration |
| Property Units | getUnitsAvailabilityAndPricing | Base Integration |
| Property Units | getAmenities | Base Integration |
| Property Units | getUnitTypes | Base Integration |
| Property Units | getSpecials | Base Integration |
| Leases | getMitsLeases | Base Integration |
| Leases | getLeasePickList | Base Integration |
| Leases | getLeaseDetails | Base Integration |
| Leases | sendLeaseDocuments | Inspection Report Sync |
| Leases | sendLeaseActivities | Base Integration, Inspection Report Sync |
| Leases | getExpiringLeases | Base Integration, Inspection Report Sync |
| Leases | getEvictedLeases | Base Integration, Inspection Report Sync |
| Leases | getLeaseDocumentList | Base Integration |
| Properties | getProperties | Base Integration |
| Properties | getPropertyPickLists | Base Integration |
| Properties | getFloorPlans | Base Integration, Inspection Report Sync |
| Maintenance | getWorkOrders | Work Order Sync, Work Order Import |
| Maintenance | sendWorkOrders | Work Order Sync, Work Order Export |
| Maintenance | updateWorkOrders | Work Order Sync, Work Order Export |
| Maintenance | getWorkOrderPickLists | Work Order Sync, Work Order Import |
Step 2: Confirm Maintenance Settings
Navigate to Residents > Maintenance > General Settings in Entrata and confirm the following settings:
| Setting | Required Value |
|---|---|
| Show Category > Problem with Work Order Creation | Yes |
| Default Permission to Enter for Entrata Generated Work Orders | No |
| Allow for the AI Generation of Closing Notes | No |
Note: If you do not plan to sync closing notes from HappyCo to Entrata, "Allow for the AI Generation of Closing Notes" can be set to Yes.
Step 3: Share Your Entrata API URL
Provide your organization's Entrata API URL to your HappyCo contact. The URL follows this format:
https://apis.entrata.com/ext/orgs/myorg/v1
Replace myorg with your organization's subdomain. Once received, HappyCo will confirm access and complete the remaining setup on our end.
Extend Your Integration
The following features can be enabled as part of your Entrata integration:
- Resident Chargebacks — Automatically post resident charges from move-out inspections to the resident's Entrata ledger. Set it up →