> ## Documentation Index
> Fetch the complete documentation index at: https://doc.fluximmo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Exemple de webhook properties

> Payload de webhook properties type, pour tester votre endpoint.

## À quoi ça sert

`GET /v2/sample/webhook/properties` retourne **le payload exact** que Fluximmo POSTerait à votre endpoint webhook lorsqu'une `Property` matche une alerte. Parfait pour :

* **Tester votre handler webhook** sans devoir attendre un vrai event en production.
* **Valider votre parser** côté serveur (déserialisation, validation de schéma, persistance).
* **Documenter** votre intégration interne avec un payload de référence stable.
* **CI/CD** : utiliser ce payload comme fixture dans les tests d'intégration de votre worker webhook.

L'endpoint ne nécessite aucune authentification (c'est un endpoint d'exemple en lecture).

## Exemple

<CodeGroup>
  ```bash curl theme={null}
  curl https://api.fluximmo.io/v2/sample/webhook/properties
  ```

  ```python Python theme={null}
  import requests, json
  payload = requests.get("https://api.fluximmo.io/v2/sample/webhook/properties", timeout=10).json()
  # Replay vers votre webhook local pour tester :
  # requests.post("http://localhost:3000/webhooks/properties", json=payload)
  print(json.dumps(payload, indent=2)[:500])
  ```

  ```javascript Node theme={null}
  const payload = await (await fetch("https://api.fluximmo.io/v2/sample/webhook/properties")).json();
  // Replay vers votre webhook local pour tester :
  // await fetch("http://localhost:3000/webhooks/properties", { method: "POST", body: JSON.stringify(payload), headers: { "Content-Type": "application/json" } });
  console.log(payload);
  ```
</CodeGroup>

## Liens utiles

* [Concept · Webhooks](/concepts/webhooks)
* [Sample properties (no-auth)](/api-v2-reference/sample-properties/get-a-sample-of-properties)
* [Sample webhook adverts](/api-v2-reference/sample-adverts/sample-advert-webhook-body)

<Card title="Clé test gratuite — 1 semaine" icon="key" href="https://my.fluximmo.io">
  Créez un compte sur **my.fluximmo.io** pour récupérer une clé API test gratuite (1 semaine, accès limité). Aucun paiement requis.
</Card>


## OpenAPI

````yaml get /v2/sample/webhook/properties
openapi: 3.0.0
info:
  title: Real-estate data API - Fluximmo V2
  description: >+
    ## Fluximmo

    ##### Real-time real estate data: Power workflows, business applications and
    decision-making.


    Real estate expert since 2017, Fluximmo aggregates, exploits, enriches &
    analyzes the 


    real-estate market in real time to offer data flows, APIs and innovative
    services to real estate professionals.


    ## Authentification

    You'll need to be authenticated with an active subscription to access our
    REST endpoints.


    To get an API-KEY please contact us at contact@fluximmo.com or book a call
    with our team: https://calendly.com/fluximmo/meet-fluximmo

    ##### How to use your API KEY

    Simply add to your HTTP request your API KEY in the headers:
    `{'x_api_key':'randomApiKey'}`


    ## Properties and Adverts

    Real-estate market can be conceptualized in different ways. We offer two
    different conceptualization depending on your needs: Properties & Adverts.

    #### Properties (BAAS)

    A property is a real-estate habitation/land/commercial/building to which is
    attached adverts.


    We gather all the adverts offering (selling or renting) this real-estate
    asset and consolidate all the information into one Property.


    A Property is by definition `de-duplicated` and can gather 1 to x adverts:
    these adverts are either duplicates from different portals or with mandates
    from different agencies or republication of the same advertising with a
    price update or not.


    The concept of property is in constant mutation until the real-estate asset
    is sold: We'll keep merging new adverts within the Property concept and
    update the price if needed.


    By it's nature in constant mutation, we do not offer the possibility to
    receive these Properties on webhooks. You'll need to use our APIs as a
    Backend As A Service (BaaS).


    #### Adverts (BAAS and WEBHOOK)

    Adverts are advertising of a real-estate property. Adverts can come from
    many sources: Agencies websites, Aggregation real-estate portals,
    Social-Networks, NewsPaper etc...


    After gathering all these adverts our proprietary AI algorithms will
    de-duplicate these adverts and associate them to a Property


    An advert have a unique URL. Meaning that the same advertising re-published
    twice (with our without any change, on the same website or not, by the same
    agency or not) is considered as 2 ads.


    You can choose either to retrieve all the Adverts or only the non duplicated
    ones. Adverts can be retrieved either by API (Search or Alerts) or Webhook

    ## Webhooks

    We offer the possibility to receive our real-estate Adverts data in
    real-time using webhooks. As soon as we gather the data, you'll receive it
    few moments later.


    Using ALERTS, you can receive new adverts matching your criteria on a
    webhook.


    ##### Webhook differences between Adverts and Properties

    As Properties are by nature in perpetual evolutions (new duplicated ads will
    be merged, new data to be consolidated etc..), we do not offer the
    possibility to receive through Webhooks the full body of the properties.
    Properties webhook will only send you the list of the properties FlxIds
    matching your search.


    You'll find below the schema of the data you would receive on your webhook
    (`/v2/sample/webhook/properties`, `/v2/sample/webhook/adverts`)

    ##### What is a webhook

    A webhook can be thought of as a type of API that is driven by events rather
    than requests


    .Instead of one application making a request to another to receive a
    response, a webhook is a service that allows one program to send data to
    another as soon as a particular event takes place.


    Webhooks are sometimes referred to as “reverse APIs,” because communication
    is initiated by the application sending the data rather than the one
    receiving it.


    With web services becoming increasingly interconnected, webhooks are seeing
    more action as a lightweight solution for enabling real-time notifications
    and data updates without the need to develop a full-scale API.

    ##### When to use a webhook instead of the REST API

    You're supposed to receive a high volume of data (frequently or not), you're
    looking for real-time data, you just have to relax and wait (no cron, no
    call on our API etc..)

    ##### Webhook implementation examples

    A webhook is simply a POST endpoint we can request

    * Python:
    https://gist.github.com/aloysius-tim/293772256526efa20d5c625c6ace036a

    * Node:
    https://gist.github.com/aloysius-tim/ea1d9feb2c527b5b09ffc356b662d14b

  version: 2.0.0
  contact: {}
  x-logo:
    url: https://www.fluximmo.com/assets/images/logo_text.png
    backgroundColor: '#F31051'
    altText: Fluximmo logo
servers:
  - url: https://api.fluximmo.io
security: []
tags:
  - name: PropertyModel
    description: <SchemaDefinition schemaRef="#/components/schemas/PropertyDto" />
  - name: AdvertModel
    description: <SchemaDefinition schemaRef="#/components/schemas/AdvertDto" />
paths:
  /v2/sample/webhook/properties:
    get:
      tags:
        - Sample Properties
      summary: Sample Properties webhook body
      description: Sample of an alert webhook body for Properties
      operationId: SampleWebhookPropertiesController_GetSampleWebhookProperties
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SampleWebhookPropertiesResponseDto'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
components:
  schemas:
    SampleWebhookPropertiesResponseDto:
      properties:
        data:
          type: object
          properties:
            created:
              type: array
              items:
                $ref: '#/components/schemas/SampleWebhookPropertiesItemDto'
            updated:
              type: array
              items:
                $ref: '#/components/schemas/SampleWebhookPropertiesItemDto'
          required:
            - created
            - updated
      required:
        - data
      type: object
    ExceptionDto:
      type: object
      properties:
        error:
          description: Error object
          allOf:
            - $ref: '#/components/schemas/ErrorDto'
      required:
        - error
    SampleWebhookPropertiesItemDto:
      type: object
      properties:
        properties:
          description: List of property flxIds
          example:
            - 7364690d-2487-46d1-832d-c5ae1cf6e861
            - 3fcf2348-756d-40e2-9bcd-3c4fd02f51d8
          type: array
          items:
            type: string
        alert_id:
          type: string
      required:
        - properties
        - alert_id
    ErrorDto:
      type: object
      properties:
        message:
          type: string
          description: Error message
        code:
          type: number
          description: Error code
      required:
        - message
        - code

````