Webhooks

Register a saved-query webhook

Register a search and a URL. When a listing that matches first appears, it is POSTed to your URL — no polling.

The body is {"webhook_id", "query", "count", "listings"}, where each listing uses the same schema as /v1/listings. Every delivery carries X-Omnia-Signature: sha256=<hex HMAC of the raw body>, keyed with the secret returned once at creation — verify it with a constant-time comparison before trusting the payload.

A new subscription starts from the moment you create it; it does not replay history. Deliveries retry until they succeed, so a 5xx on your side is resent rather than lost, and a URL that fails 10 times in a row is parked. Your URL must be public HTTPS. Limit 10 active webhooks per key.

post/v1/webhooks

Request

  • Base URL: https://api.omniaauto.ca
  • URL: https://api.omniaauto.ca/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
queryobject

Any /v1/listings filter: province, make, model, trim, year, condition, body_type, drivetrain, fuel_type, city, oem, price_min/max, mileage_min/max, year_min/max.

Example request

{
  "url": "https://example.com/hooks/omnia",
  "query": {
    "province": "AB",
    "make": "Ford",
    "condition": "New"
  }
}

Response

Created — the signing secret is returned ONCE

Changes

No recorded changes to this operation across all 1 revision of this API.