This tutorial is split into four steps:

  1. Creating your webhook
  2. Verifying your callback URI
  3. Confirmation with a test payload
  4. Subscribing your first vehicle

Event Based Webhooks are an Enterprise feature. Please reach out to our team to get them enabled.

Prerequisites

For this tutorial it’s recommended to have the following in place:

  • To recevie webhooks you’ll need to set up a callback URI on your server.
  • To subscribe a vehicle you’ll want to have Connect set up.

Creating your first webhook

  1. Navigate to the Webhooks section of Dashboard and hit + Add Webhook.
  2. Next, name your webhook, enter in your callback URI, and select Event as the type.
  3. After selecting the type, you’ll need to select which events you’d like to receive.
  4. Once you’re happy with the configuration, hit Add Webhook and move on to verifying your callback URI.

Verifying your callback URI

After adding your webhook, you’ll be prompted to verify it. After hitting Verify this webhook Smartcar will post a challenge request to your callback URI to ensure we’re sending payloads to the correct place.

This is a one time event and will be in the following format where the eventName will be verify

verificationRequest.body
    {
        "version": "2.0",
        "webhookId": "<uuid>",
        "eventName": "verify",
        "payload": { "challenge": "<random-string>" }
    }

Upon receiving the request, your server will need respond to the challenge by hashing payload.challenge with your APPLICATION_MANAGEMENT_TOKEN to create a SHA-256 based HMAC.

You can find your APPLICATION_MANAGEMENT_TOKEN in the Configuration section of Dashboard for your applicaiton.

Return the hex-encoded hash as the value for challenge in your response body with a 2XX status code.

verificationResponse.body
{
    "status" : 204,
    "headers" : {
        "Content-Type": "application/json"
    },
    "body" : {
        "challenge" : "{HMAC}"
    }
}

See the callback verification section on our API Refrence for more information.

Confirmation with a test payload

Once verified you can send a test payload to your callback URI. Payloads from vehicles will have eventName set to eventBased.

Event Based webhooks are only supported for live vehicles.

{
  "version": "2.0",
  "webhookId": "2bc671d0-b712-4cac-8837-50deeb474605",
  "eventName": "eventBased",
  "mode": "test",
  "payload": {
    "eventId": "68f4179e-0648-4795-a4d8-0b553c2c635c",
    "vehicleId": "00000000-0000-4000-A000-000000000000",
    "eventType": "CHARGING_COMPLETED",
    "eventTime": "2023-08-24T15:49:24.855Z"
  }
}

Subscribing your first vehicle

Now you’ve got your webhook set up, you can subscribe vehicles to start getting data at your desired frequency. If you haven’t done so already, please set up the Connect for your application.

After receivng your initial ACCESS_TOKEN from the auth code excahnge step for Connect, you’ll first want to hit the All Vehicles endpoint to fetch the Smartcar vehicle_ids of the authorized vehicles.

curl "https://api.smartcar.com/v2.0/vehicles" \
-H "Authorization: Bearer {token}" \
-X "GET"

With your ACCESS_TOKEN and WEBHOOK_ID you can hit the Subscribe endpoint for each vehicle_id to start receiving data.

curl "https://api.smartcar.com/v2.0/vehicles/{vehicleId}/webhooks/{webhookId}" \
-H "Authorization: Bearer {token}" \
-X "POST"

FAQs

Was this page helpful?