Articles on: Integrations

API data and webhook events available in Plexflow

Plexflow offers integration options that let you connect certain platform data to external tools. Depending on the need, you can use the API to consult information from Plexflow, or webhooks to be notified automatically when a specific event occurs in the platform.

The API is mainly used to retrieve data, such as information related to units, buildings, rents, tenants, and certain important dates. Webhooks, for their part, let you trigger an action or send a notification to another system when an event occurs, for example when a rent is created, a payment succeeds, or a status is updated.

This article presents the main data available through the Plexflow API, as well as the webhook events that can be used to automate certain processes or synchronize information with other tools.

Webhook events

Prospective tenants

Prospective Tenant Created
Prospective Tenant Modified

Leases

Rent Created
Rent Renewed

Tenants

Tenant Confirmed
Tenant Activated
Tenant Deactivated
Tenant Created
Tenant Deleted
Tenant Modified

Service requests

Service Request Created
Service Request Modified
Service Request Closed
Service Request Deleted

Service request notes

Service Request Note Created
Service Request Note Deleted

Payments

Invoice Paid
Invoice Modified
Invoice Failed
Invoice Reversed
Invoice Deleted

Units

Unit Vacancy Started
Unit Vacancy Ended

Data available in the API

General information

count: total number of units returned.
units: list of units available in the API response.

Unit information

unitId: unique identifier of the unit.
unitNickname: name or number of the unit.
unitAddress: full address of the unit.
apptNb: apartment number.
floorLevel: floor of the unit.
surfaceArea: area of the unit.
unitType: type of unit, for example 3.5, 5.5, 6.5.
hasWaterHeater: indicates whether the unit has a water heater.
marketPrice: market price.
marketRenewalPrice: suggested price at renewal.

Building information

propertyId: unique identifier of the building.
propertyNickname: name or nickname of the building.
propertyAddress: full address of the building.
subaccount: subaccount or company associated with the unit.

Building address details

In propertyAddressDetails, you will find:

latitude: latitude of the building.
longitude: longitude of the building.
formattedAddress: full formatted address.
streetName: street name.
streetNumber: street number.
postalCode: postal code.
province: province.
city: city.
country: country.
apptNb: apartment number, if applicable.

Rent information

rentId: rent identifier.
rentStatus: numeric status of the rent.
statuses: human-readable statuses of the unit or the rent, for example Active, Scheduled, Pending.
rentEnding: identifier of the rent that is ending.
rentStarting: identifier of the rent that is starting.
rentBeforeDiscount: rent amount before discounts.

Current rent amounts

The amounts appear to be expressed in cents.

currentRentBeforeDiscountsCents: current rent before discounts.
currentRentDiscountsCents: discount applied to the current rent.
currentRentServicesCents: amount of the services linked to the current rent.
currentRentTotalCents: current rent total.

Scheduled rent amounts

scheduledRentBeforeDiscountsCents: scheduled rent before discounts.
scheduledRentDiscountsCents: discount planned on the scheduled rent.
scheduledRentServicesCents: services planned on the scheduled rent.
scheduledRentTotalCents: scheduled rent total.

Tenant information

tenantsLeaving: outgoing tenants.
tenantsEntering: incoming tenants.
dateTenantLeaving: tenant move-out date.
dateTenantEntering: tenant move-in date.
enteringDate: start date.
leavingDate: end date.
markedWontRenew: indicates whether the tenant is marked as not renewing.

Unit availability

dateAvailableForRent: date on which the unit is available to rent.
dateAvailableForMaintenance: date on which the unit is available for work or maintenance.

Updated on: 13/11/2026

Was this article helpful?

Thank you!