Simulate
This endpoint will simulate a match
or an event
to the given endpoint.
curl --location --request GET 'https://api.notif.immo/webhook-tester' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \
Restricting your endpoints to our IP addresses is highly recommended for security reasons:
- Sandbox:
178.238.226.136
- Production:
195.201.86.35
136.243.17.46
Your server implementation should return a 200
HTTP status code if the data was received successfully. If a webhook fails, it will be retried up to five times. Every retry will take place 1 hour after the previous one.
In order to use webhooks in production, you need to provide on POST /searches an endpointRecipient
to receive new matches in real time or/and an eventEndpoint
to receive new advert events in real time.
You can choose the events you want to subscribe to using the subscribedEvents
parameter. All types of events are listed below this section.
You also need to set the notificationEnabled
parameter to true
in order to receive webhooks.
Match Events | Description |
---|---|
property.ad.create | Notifies you when a new advert is created. |
property.ad.update | Notifies you when an existing advert is updated. |
Advert Events | Description |
---|---|
ad.update.price | Notifies you when the price of an advert changes. |
ad.update.surface | Notifies you when the surface area of an advert changes. |
ad.update.pictures | Notifies you when the pictures of an advert are updated. |
ad.update.expired | Notifies you when an advert has expired. |
Path
Endpoint where the match or the event will be sent to.
The type of event you want to trigger.
curl --location --request GET 'https://api.notif.immo/webhook-tester' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \