Skip to main content
WEBHOOK

Autorisations

Authorization
string
header
requis

Send your Immoteur Personal Access Token in the Authorization header: Authorization: Bearer <token>

You can create and manage your Personal Access Tokens here: https://immoteur.com/dashboard/settings status: current: available

En-têtes

User-Agent
string
requis

Identifies the request as an Immoteur webhook call.

X-Immoteur-Service-Id
string<uuid>
requis

UUID of the Immoteur service emitting this webhook.

X-Immoteur-Event-Id
string<uuid>
requis

Correlation ID for the webhook payload.

X-Immoteur-Delivery-Id
string<uuid>
requis

Unique identifier for this HTTP delivery attempt.

X-Immoteur-Timestamp
string
requis

Unix timestamp (seconds) for the delivery attempt.

Pattern: ^[0-9]+$

Corps

application/json

Export webhook payload. Every message includes batchId, itemCount, and batchCount; data messages have a non-null batchId and totals confirmed before that attempt, while the final message has batchId null, an empty items list, and definitive totals. Receivers should reconcile acknowledgement records by batchId, but process Classified contents idempotently because a retry can contain different items for the same batchId.

batchCount
integer
requis

Number of distinct data-message cursors for which Immoteur had durably confirmed a 2xx response before this delivery attempt. On the terminal completion message, this is the definitive export batch total.

Plage requise: x >= 0
batchId
string<uuid> | null
requis

Deterministic identifier for the current data-message cursor, derived from the export, partition, and cursor. It remains unchanged across retries until Immoteur observes a 2xx response, then changes as the cursor advances; it is null on the terminal completion message.

exportId
string<uuid>
requis

Export identifier for correlating chunks.

exportType
enum<string>
requis

Effective type delivered for the entire export. full delivers all currently matching public-exportable listings. A Delta export delivers full public Classified snapshots selected from durable change-ledger changes since a compatible successful baseline, including changes useful for reconciliation that did not produce direct live notifications. It is included in every data batch and terminal completion message. A requested Delta export that falls back is delivered as full; the receiver payload does not include the requested mode or the fallback reason.

Options disponibles:
delta,
full
isComplete
boolean
requis

False for data batches; true only for the final empty completion notification.

itemCount
integer
requis

Total number of classified items across distinct data-message cursors for which Immoteur had durably confirmed a 2xx response before this delivery attempt. On the terminal completion message, this is the definitive export item total.

Plage requise: x >= 0
items
object[]
requis

Collection of classifieds included in this webhook call.

Réponse

Webhook received successfully