Skip to main content

Enquiry Webhooks

Vyro can push a lead / enquiry (called a moment in Vyro) to your API whenever a customer submits an enquiry. This document outlines how we deliver leads, what authentication methods we support, and the JSON payload format you can expect.

1. When We Call Your API​

Vyro sends a webhook whenever a new moment is inserted into our system.

HTTP Method: POST
Content-Type: application/json

Example Headers​

Authorization: Bearer <your-api-token>
X-Source-System: Vyro
X-Event-Type: moment.inserted

2. Example Lead Payload​

{
  "id": "f96c6d67-5a5b-4fb9-9df9-5c0f9a5a5e11",
  "created_at": "2025-11-14T02:15:23.456Z",
  "channel": "website_form",
  "customer": {
    "id": "b8f6b80f-09aa-4db6-8a72-9b2a8a7230a1",
    "first_name": "Jane",
    "last_name": "Doe",
    "full_name": "Jane Doe",
    "email": "jane.doe@example.com",
    "phone": "+61 400 000 000"
  },
  "vehicle": {
    "id": "b1f7bfec-8fb4-4d4e-94f8-8c3a37aaae22",
    "stock_id": "ABC123",
    "vin": "WBA12345678901234",
    "year": 2024,
    "make": "Polestar",
    "model": "2",
    "badge": "Long Range Single Motor",
    "condition": "new",
    "location": {
      "id": "d2c2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
      "name": "Sydney Dealership"
    },
    "listing_url": "https://example-showroom.com/vehicles/stocked/ABC123"
  },
  "showroom": {
    "id": "f1c1ed11-48b7-4b7b-b43a-bc0a12345678",
    "name": "Example Showroom",
    "domain": "example-showroom.com"
  },
  "message": "Example message"
}

3. Authentication Options​

Authorization: Bearer YOUR_STATIC_TOKEN

Or:

X-API-Key: YOUR_STATIC_TOKEN

3.2 HTTP Basic Authentication​

Authorization: Basic <base64(username:password)>

3.3 OAuth 2.0 (Client Credentials Flow)​

Authorization: Bearer <access_token>

Vyro handles token retrieval and refresh for you.

4. What We Need From You​

  • Endpoint URL\
  • Preferred authentication method\
  • Required fields or schema constraints\
  • Expected success response (200 or 201)