Skip to main content
Version: v1.0

Changelog

Integration contract change history.

Versioning​

We use semantic versioning:

  • MAJOR (X.0.0): breaking change (e.g. new required field, field rename, format change).
  • MINOR (0.X.0): new optional field, new non-blocking validation rule, new endpoint.
  • PATCH (0.0.X): documentation fix, threshold adjustment, message improvements.

Current version​

v1.0.0 — Initial integration contract.

Change policy​

  • Deprecated fields: marked as such in Property Schema and kept functional for at least 90 days.
  • New validation rules (BLOCK): announced at least 30 days in advance so you can adjust your data.
  • Endpoint changes (URL or HTTP method): at least 90 days notice.

Changes are documented in this changelog. Major changes (MAJOR) are communicated in advance.

v1.0.0 (2026-06-30)​

First public version of the integration contract.

Included documents:

  • Property Schema: property JSON definition.
  • Pull Protocol: GET endpoint contract.
  • Feedback Webhook: POST webhook contract.
  • Lifecycle: property states over time.
  • Deletion Protocol: explicit deletion and reconciliation.
  • Security: authentication, HMAC, TLS.
  • QA Rules: validation rules catalog.
  • Error Catalog: error codes.
  • Examples: concrete use cases.
  • Quickstart: integration guide.

Property schema:

  • 6 required fields: external_id, property_type, city, state, rent_price|sale_price, updated_at.
  • 7 canonical property_type values.
  • 2 supported currencies: MXN, USD.
  • 3 modalities: rent, sale, rent_and_sale.
  • 19 amenities with keyword matching.
  • Type-specific fields: industrial, office, retail, land.

Validations:

  • 19 BLOCK rules.
  • 7 DRAFT rules.
  • 1 WARN rule.

Webhook:

  • 2 events: item_accepted, item_rejected.
  • HMAC-SHA256 for authenticity verification.
  • Deduplication via request_id.
  • Messages in Spanish (configurable to English).