Données API et événements Webhooks disponibles dans Plexflow

Plexflow offre des options d’intégration permettant de connecter certaines données de la plateforme à des outils externes. Selon le besoin, il est possible d’utiliser l’API pour consulter des informations provenant de Plexflow, ou les Webhooks pour être informé automatiquement lorsqu’un événement précis se produit dans la plateforme.

L’API sert principalement à récupérer des données, comme les informations liées aux logements, aux immeubles, aux loyers, aux locataires et à certaines dates importantes. Les Webhooks, de leur côté, permettent de déclencher une action ou d’envoyer une notification vers un autre système lorsqu’un événement survient, par exemple la création d’un loyer, la réussite d’un paiement ou la mise à jour d’un statut.

Cet article présente les principales données disponibles via l’API Plexflow, ainsi que les événements Webhooks pouvant être utilisés pour automatiser certains processus ou synchroniser l’information avec d’autres outils.

Événements Webhooks

Contacts prospects

• Contact prospect créé
• Contact prospect modifié

Baux

• Bail créé
• Bail renouvelé

Locataires

• Locataire confirmé
• Locataire activé
• Locataire désactivé
• Locataire créé
• Locataire supprimé
• Locataire modifié

Demandes de service

• Demande de service créée
• Demande de service modifiée
• Demande de service fermée
• Demande de service supprimée

Notes de demandes de service

• Note de demande de service créée
• Note de demande de service supprimée

Paiements

• Paiement reçu
• Paiement modifié
• Paiement échoué
• Paiement remboursé
• Paiement supprimé

Unités

• Unité devenue vacante
• Unité occupée

Données disponibles dans l’API

Informations générales

• count : nombre total de logements retournés.
• units : liste des logements disponibles dans la réponse API.

Informations sur le logement

• unitId : identifiant unique du logement.
• unitNickname : nom ou numéro du logement.
• unitAddress : adresse complète du logement.
• apptNb : numéro d’appartement.
• floorLevel : étage du logement.
• surfaceArea : superficie du logement.
• unitType : type de logement, par exemple 3.5, 5.5, 6.5.
• hasWaterHeater : indique si le logement possède un chauffe-eau.
• marketPrice : prix du marché.
• marketRenewalPrice : prix suggéré au renouvellement.

Informations sur l’immeuble

• propertyId : identifiant unique de l’immeuble.
• propertyNickname : nom ou surnom de l’immeuble.
• propertyAddress : adresse complète de l’immeuble.
• subaccount : sous-compte ou compagnie associé au logement.

Détails de l’adresse de l’immeuble

Dans propertyAddressDetails, on retrouve :

• latitude : latitude de l’immeuble.
• longitude : longitude de l’immeuble.
• formattedAddress : adresse formatée complète.
• streetName : nom de la rue.
• streetNumber : numéro civique.
• postalCode : code postal.
• province : province.
• city : ville.
• country : pays.
• apptNb : numéro d’appartement, si applicable.

Informations sur le loyer

• rentId : identifiant du loyer.
• rentStatus : statut numérique du loyer.
• statuses : statuts lisibles du logement ou du loyer, par exemple Active, Scheduled, Pending.
• rentEnding : identifiant du loyer qui se termine.
• rentStarting : identifiant du loyer qui commence.
• rentBeforeDiscount : montant du loyer avant rabais.

Montants du loyer actuel

Les montants semblent être exprimés en cents.

• currentRentBeforeDiscountsCents : loyer actuel avant rabais.
• currentRentDiscountsCents : rabais appliqué au loyer actuel.
• currentRentServicesCents : montant des services liés au loyer actuel.
• currentRentTotalCents : total du loyer actuel.

Montants du loyer programmé

• scheduledRentBeforeDiscountsCents : loyer programmé avant rabais.
• scheduledRentDiscountsCents : rabais prévu sur le loyer programmé.
• scheduledRentServicesCents : services prévus sur le loyer programmé.
• scheduledRentTotalCents : total du loyer programmé.

Informations sur les locataires

• tenantsLeaving : locataires sortants.
• tenantsEntering : locataires entrants.
• dateTenantLeaving : date de départ du locataire.
• dateTenantEntering : date d’arrivée du locataire.
• enteringDate : date d’entrée.
• leavingDate : date de sortie.
• markedWontRenew : indique si le locataire est marqué comme ne renouvelant pas.

Disponibilité du logement

• dateAvailableForRent : date à laquelle le logement est disponible pour location.
• dateAvailableForMaintenance : date à laquelle le logement est disponible pour travaux ou maintenance.

Mis à jour le : 08/05/2026