Getting Started

Learn how to integrate Driver Events into your platform using Suntransfers webhooks.

Overview

Driver Events provide updates on the progress of a transfer, from pickup to drop-off.

Through webhooks, Suntransfers automatically sends these updates to your platform, allowing you to track transfer progress and keep your customers informed throughout their journey.

Each event is associated with a specific leg of a booking and provides information about what happened and when.

Events may include driver departure, arrival at pickup, passenger no-show, departure towards the drop-off point, arrival at the destination, and live location updates.

For more information about the available events and their data structure, see Event Types & Data Model.

Prerequisites

Before getting started, you will need:

  • A Suntransfers partner account in Staging and Production.
  • An HTTPS endpoint capable of receiving webhook requests from Suntransfers.

How to get started

  1. Understand Driver Events. Review the available event types and their data structure in Event Types & Data Model
  2. Set up your webhook integration. Follow the instructions in Webhooks to configure your endpoint and receive events.
  3. Test in Staging. Validate that your integration can successfully receive and process Driver Events.
  4. Go live. Once testing is complete, configure your integration in Production.