Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

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

Headers

User-Agent
string
required

Identifies the request as an Immoteur webhook call.

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

UUID of the Immoteur service emitting this webhook.

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

Correlation ID for the webhook payload.

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

Unique identifier for this HTTP delivery attempt.

X-Immoteur-Timestamp
string
required

Unix timestamp (seconds) for the delivery attempt.

Pattern: ^[0-9]+$

Body

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
required

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.

Required range: x >= 0
batchId
string<uuid> | null
required

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>
required

Export identifier for correlating chunks.

exportType
enum<string>
required

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.

Available options:
delta,
full
isComplete
boolean
required

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

itemCount
integer
required

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.

Required range: x >= 0
items
object[]
required

Collection of classifieds included in this webhook call.

Response

Webhook received successfully