Skip to main content

Notification on Booking Status Change

Webhook

The bookingStatus webhook event is triggered when there is a change in the status of a booking. It provides comprehensive updates for each stage of the booking process, such as when the booking is accepted, a driver is assigned, the driver is en route, the passenger is on board, and up to the point of drop-off or cancellation. This event allows for real-time tracking and management of bookings.

Supported roles

  • Partner
  • Fleet manager

Request​

Header Parameters

    x-gojo-request-signature stringrequired

    HMAC hash combining your shared secret and the request payload. Utilize this hash to authenticate and validate incoming requests from Good Journey. This ensures the security and integrity of the data received.

Body

    bookId stringrequired
    source string

    Booking source:

    • Command Center
    • Car-hailing
    • Street sharing
    • Partner
    • Passenger app
    • API
    • PWA
    • Booking.com
    • HolidayTaxis
    • Hoppa
    status string

    Booking status:

    • accepted - Provider accepted
    • driverAssigned - Booking has been assigned to driver
    • driverOnTheWay - Driver has started job and on the way to the pickup point
    • passengerOnBoard - Passenger has been picked up
    • droppedOff - Dropped off
    • canceled - Canceled
    • passengerNoShow - Passenger was a no-show
    • incident - Booking has been marked as incident by the provider
    • completed - Completed
    bookingReference string
    passenger object
    title string
    firstName string
    lastName string
    phone stringrequired

    Phone number in E.164 format

    email string
    driver object
    phone string

    Phone number in E.164 format

    firstName string
    lastName string
    pickup object
    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    destination object
    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    pickupDateTime date-time

    Pickup time in UTC timezone

    vehicleType string
    comment string
    noPassengers integer

    Number of passengers

    noLuggage integer

    Number of luggage

    price object
    value numberrequired
    currency stringrequired
Loading...