Third Party Subscription Integration

The below payload is for third party platforms to integrate with Dealer Studio for finance / subscription lead delivery. The third party must provide an endpoint which accepts API bearer tokens.

Outbound subscription leads use the standard lead webhook (LeadExports::WebhookService). Contact PII (licence, date of birth, address, marketing opt-in) is read from the contact record, not from lead.fields.

Webhook structure from Dealer Studio to third party system

Relevant prospect and subscription_plan sections (schema version v1):

{
  "category": "Subscription Enquiry",
  "prospect": {
    "first_name": null,
    "name": "Bruce Smith",
    "middle_name": "James",
    "last_name": "Smith",
    "email": "brandon@example.com",
    "mobile_phone": "0412345678",
    "postcode": 4000,
    "dob": "1994-09-12",
    "driver_licence_number": "1234567890",
    "drivers_license_number": "1234567890",
    "drivers_license_card_number": "1234567890",
    "drivers_license_state": "NSW",
    "drivers_license_expiry": "2029-12-12",
    "marketing_opt_in": true,
    "address": {
      "street": "123 Eagle Street",
      "city": "Brisbane",
      "state": "QLD",
      "postcode": 4000,
      "country": "Australia"
    }
  },
  "item": {
    "id": 1234567890,
    "make": "Toyota",
    "model": "Corolla",
    "year": 2020,
    "vin": "1234567890",
    "stock_number": "1234567890"
  },
  "subscription_plan": {
    "subscription_id": 1234567890,
    "name": "Basic",
    "monthly_price_for_car": 100.0,
    "weekly_price_for_car": 25.0,
    "fortnightly_price_for_car": 50.0,
    "daily_price_for_car": 4.0
  },
  "subscription": {
    "newsletter": true
  }
}

Notes:

• driver_licence_number is kept for backward compatibility; prefer drivers_license_number.
• marketing_opt_in mirrors contact.opt_in_to_marketing (also reflected on subscription.newsletter via lead.opt_in).
• Licence, DOB, and address values are taken from the contact after lead create; they are not retained on lead.fields.