Legacy Docs

Vehicles Webhooks

Sent when vehicles are added, updated, or removed.

#Added

post/v2/webhooks

The vehicles.added webhook is sent when a new vehicle object is added, either during an initial scan or re-scan of an account.

Request body
  • eventsarray of strings
    required

    vehicles.added

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • eventstring

    vehicles.added

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • accountstring

    ID of the account.

  • userobject

    ID of the user.

  • vehicleobject

    ID of the vehicle.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v2/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["vehicles.added"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "vehicles.added",
3  "name": "name-for-the-webhook-subscription",
4  "data": {
5    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7    "vehicle": "01763a69-5cbe-2edb-ade1-5591157c354d"
8  }
9}

#Updated

post/v2/webhooks

The vehicles.updated webhook is sent when there is any change to a property value of a vehicle object.

Request body
  • eventsarray of strings
    required

    vehicles.updated

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • eventstring

    vehicles.updated

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • accountstring

    ID of the account.

  • userobject

    ID of the user.

  • vehicleobject

    ID of the vehicle.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v2/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["vehicles.updated"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "vehicles.updated",
3  "name": "name-for-the-webhook-subscription",
4  "data": {
5    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7    "vehicle": "01763a69-5cbe-2edb-ade1-5591157c354d"
8  }
9}

#Removed

post/v2/webhooks

The vehicles.removed webhook is sent when a vehicle object has been deleted due to a previous vehicle not being found during an account re-scan.

This webhook is not sent when an account is deleted via the API, or a user revokes access to their account.

Request body
  • eventsarray of strings
    required

    vehicles.removed

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • eventstring

    vehicles.removed

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • accountstring

    ID of the account.

  • userobject

    ID of the user.

  • vehicleobject

    ID of the removed vehicle object.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v2/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["vehicles.removed"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "vehicles.removed",
3  "name": "name-for-the-webhook-subscription",
4  "data": {
5    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7    "vehicle": "01763a69-5cbe-2edb-ade1-5591157c354d"
8  }
9}