Skip to main content
Create a new alert for this Property search
Avant de créer une alerte, vérifier que ton webhook répond 200 aux données de sample disponibles sans auth (GET /v2/sample/webhook/properties).
PUT /v2/protected/properties/search/alerts crée une alerte properties : à chaque property qui matche search_query, Fluximmo POSTe sur webhook_url un payload IDs only que vous refetchez ensuite via GET /v2/protected/properties/{flxId} ou en bulk via /properties/bulk. Le search_query réutilise le schéma de POST /v2/protected/properties/search. Pas de backfill à la création. Seules les properties créées / mises à jour après la création de l’alerte déclenchent un webhook.

Champs clés

  • search_query — payload FilterProperty, identique au search.
  • webhook_url — endpoint HTTPS public (cf. Webhooks).
  • match — tableau parmi ALERT_MATCH_CREATED (nouvelle property qualifiée) et ALERT_MATCH_MERGED (uniquement quand une nouvelle advert vient d’être fusionnée dans une property déjà matchée — pas à la création). Voir Match types & cycle alerte.
  • search_name — libellé humain.
  • context — objet QueryContextDto { metadata: object } propagé tel quel dans chaque webhook. Exemple : "context": {"metadata": {}} (objet, pas une string sérialisée).
Combo standard recommandé : match: ["ALERT_MATCH_CREATED"] seul. L’ajout de ALERT_MATCH_MERGED est un mode avancé qui multiplie le volume webhook (chaque enrichissement / fusion d’une property déjà matchée déclenche un nouvel appel). À réserver aux cas où vous voulez aussi recevoir les fusions a posteriori (analytics historique, scoring continu).

Cas d’usage

  • Marketplace / réplication BDD — synchroniser un référentiel de biens dédupliqués.
  • Analytics fintech — capter le flux de nouvelles properties d’un département pour stats temps réel.
  • AVM — alimenter un modèle d’estimation au fil de l’eau avec des biens nouvellement vus.

Exemples

C1 ★★ — Combo standard (default match=[CREATED])

Achat appartement Paris 1er, exclusion des biens totalement offline. Volume webhook minimal.

C2 — Département + isTotallyOffline=false (analytics fintech)

Toutes les nouvelles properties d’achat dans un département, exclusion offline.

C3 — match=[CREATED, MERGED] AVANCÉ

Recevoir aussi les fusions (= une property déjà matchée a été enrichie : nouvel advert rattaché, prix recalculé, etc.).
Ce mode génère plus de webhooks uniquement quand une nouvelle advert est fusionnée dans une property déjà matchée — pas à chaque check de fraîcheur. Sur des filtres larges et un volume d’ingestion élevé, mesurez votre capacité receiver avant d’activer ALERT_MATCH_MERGED.

Authorizations

x-api-key
string
header
required

Body

application/json
search_query
object
required
webhook_url
string
search_name
string
match
enum<string>[]
Available options:
ALERT_MATCH_UNKNOWN,
ALERT_MATCH_CREATED,
ALERT_MATCH_MERGED
Example:
context
object

Response

data
object
required