For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Talk to usGet started
OverviewAPI Reference
OverviewAPI Reference
    • Introduction
    • Quick Start
  • Integrations
    • Overview
    • Custom Automations
    • Using Our Actions
    • Using Our Webhooks
      • Vin
Logo
Talk to usGet started
On this page
  • Vin Webhooks
  • vAuto Vehicle Status Object
  • vin.vehicle.created
  • vin.vehicle.update
  • vin.vehicle.deleted
  • Vin Appointment Status Object
  • vin.appointment.created
  • vin.appointment.statusUpdated
IntegrationsUsing Our Webhooks

Vin

Was this page helpful?
Previous
Built with

Vin Webhooks

We support webhooks for the following events on the Vin and vAuto platforms:

  • vAuto Vehicles
  • Vin Appointments

When a vehicle’s status changes, this webhook event will be triggered with the updated information.

vAuto Vehicle Status Object

vin.vehicle.created

Occurs when a vehicle is created in the vAuto inventory.

Sample Response
1{
2"dealerName":"Van Horn CDJR of Manitowoc",
3"linkedAccountId":"72f88e1a-dff7-4705-936d-ba733da1a69d",
4"status":1,
5"type":"vin.vehicle.created",
6"vin":"5N1BT3AB6NC707140"
7}
1{
2  "dealerName": string,
3  "linkedAccountId": string,
4  "status": integer,
5  "type": string,
6  "vin": string
7}

vin.vehicle.update

Occurs when a vehicle is updated in the vAuto inventory.

Sample Response
1{
2  "item": {
3    "vin": "3C4PDDEG2ET315408",
4    "status": 1,
5    "dealerName": "Van Horn Motors of Sheboygan"
6  },
7  "fieldsChanged":{
8    "status":{
9      "from" : 1,
10      "to:" : 2
11    },
12    "dealerName": {
13        "from": "Van Horn Honda of Glendale",
14        "to": "Van Horn Motors of Sheboygan"
15      }
16  },
17}
1{
2  "item": {
3    "vin": string,
4    "status": integer,
5    "dealerName": string
6  },
7  "fieldsChanged":{
8    "status":{
9      "from" : integer,
10      "to:" : integer
11    },
12    "dealerName": {
13        "from": string,
14        "to": string
15      }
16  },
17}

vin.vehicle.deleted

Occurs when a vehicle is deleted from the vAuto inventory, usually because it was sold.

Sample Response
1{
2"dealerName":"Van Horn CDJR of Manitowoc",
3"linkedAccountId":"72f88e1a-dff7-4705-936d-ba733da1a69d",
4"status":1,
5"type":"vin.vehicle.deleted",
6"vin":"5N1BT3AB6NC707140"
7}
1{
2  "dealerName": string,
3  "linkedAccountId": string,
4  "status": integer,
5  "type": string,
6  "vin": string
7}

Vin Appointment Status Object

When a customer’s appointment changes, this webhook event will be triggered with the updated information.

vin.appointment.created

Occurs when an appointment is created in the Vin system.

Sample Response
1{
2  "dealerId": 5227,
3  "appointmentId": 123623823,
4  "status": "COMPLETED"
5}
1{
2  dealerId : integer,
3  appointmentId : integer,
4  status : 'ACTIVE' | 'MISSED' | 'COMPLETED' | 'CANCELED'
5}

vin.appointment.statusUpdated

Occurs when an appointment is updated in the Vin system.

Sample Response
1{
2  "appointmentId":123859149,
3  "dealerId":18192,
4  "fieldsChanged":  
5    {
6      "status":
7      { 
8        "from": "ACTIVE",
9        "to": "COMPLETED"
10      }
11    },
12  "linkedAccountId": "72f88e1a-dff7-4705-936d-ba733da1a69d",
13  "status": "COMPLETED",
14  "type": "vin.appointment.statusUpdated"
15}
1{
2  "appointmentId": integer,
3  "dealerId": integer,
4  "fieldsChanged":  
5    {
6      "status":
7      { 
8        "from": "ACTIVE" | "MISSED" | "COMPLETED" | "CANCELED",
9        "to": "ACTIVE" | "MISSED" | "COMPLETED" | "CANCELED"
10      }
11    },
12  "linkedAccountId": string,
13  "status": "ACTIVE" | "MISSED" | "COMPLETED" | "CANCELED",
14  "type": string
15}