TransitQuote API Reference – Webhooks

Posted on July 27, 2020 by HQ - FAQ

The TransitQuote API features are available via a free plugin which is currently in beta and available on request.

This page documents the webhooks that are currently available, the events that trigger them and the data that is sent when the webhook is triggered.

Webhooks

Webhooks are used to send real time alerts when something happens on your website.

There are three alerts that you can use within apps outside of TransitQuote.

New Quote

Triggered when a customer enters two addresses in the booking form, a price quote is generated and displayed on screen.

The New Quote webhook will send the following data in json format to any URL that you register in the settings.

Data sent

event_type_id
event_name
data
- event_name
- quote
  - job_rate (Standard, Out Of Hours, Weekend, Holiday, Dispatch, Return)
  - distance_cost
  - time_cost
  - basic_cost
  - tax_cost
  - total
- journey
  - locations (array of locations with fields as follows)
    - journey_order
    - unit_no
    - street_address
    - district
    - state
    - postal_code
    - country
    - contact_name
    - contact_phone
    - date (custom solutions only)
    - time (custom solutions only)
  - directions (raw Google Directions json)
  - distance (full distance in the selected distance unit)
  - hours (journey length in decimal hours)
- options
  - Contains a list of all options in the dashboard which affect the price of the job

New Job

Triggered when the customer selects the Book Online or Pay Now (WooCommerce Payment) buttons which saves the job details in the database.

event_type_id
event_name
data
- timestamp
- id (numerical id of job)
- job_ref (job reference formatted as per user settings)
- recieved (date and time recieved)
- delivery_time (date and time – can be used for pick up or delivery depending on settings)
- job_status
  - id
  - name
- payment_method
  - id
  - name
- payment_status
  - id
  - name
- customer
  - first_name
  - last_name
  - email
  - phone
  - wp_user_id
- quote
  - job_rate (Standard, Out Of Hours, Weekend, Holiday, Dispatch, Return)
  - distance_cost
  - time_cost
  - set_amount
  - basic_cost
  - tax_cost
  - total
- journey
  - locations (array of locations with fields as follows)
    - journey_order
    - unit_no
    - street_address
    - district
    - state
    - postal_code
    - country
    - contact_name
    - contact_phone
    - date (custom solutions only)
    - time (custom solutions only)
    - directions (raw Google Directions json)
- options
  - Contains a list of all options in the dashboard which affect the price of the job

Job Updated

Triggered when:

An admin changes the job status in the dashboard
A driver uses TransitTeam to update the job status via the my job list page
The job status is updated via an app using the REST API

event_type_id
event_name
data
- user (user who changed job status)
  - wp_user_id (WordPress user id)
  - username (wordpress username)
  - id (driver id in TransitTeam)
  - first_name (driver first name in TransitTeam)
  - last_name (driver last name in TransitTeam)
  - email (email address of driver or wp user that performed the update)
  - phone (contact no for driver or wp user that performed the update)
- timestamp
- id (numerical id of job)
- job_ref (job reference formatted as per user settings)
- recieved (date and time recieved)
- delivery_time (date and time – can be used for pick up or delivery depending on settings)
- job_status
  - id
  - name
- payment_method
  - id
  - name
- payment_status
  - id
  - name
- customer
  - first_name
  - last_name
  - email
  - phone
  - wp_user_id
- quote
  - job_rate (Standard, Out Of Hours, Weekend, Holiday, Dispatch, Return)
  - distance_cost
  - time_cost
  - set_amount
  - basic_cost
  - tax_cost
  - total
- journey
  - locations (array of locations with fields as follows)
    - journey_order
    - unit_no
    - street_address
    - district
    - state
    - postal_code
    - country
    - contact_name
    - contact_phone
    - date (custom solutions only)
    - time (custom solutions only)
    - directions (raw Google Directions json)
- options
  - Contains a list of all options in the dashboard which affect the price of the job

What our Clients say Testimonials

Our plugin is updated and all working perfectly now.
Thanks so much for your excellent service!

Ado able2tour.com

I would like to say thank you for going through that step by step with me. It was very nice working with you on this matter. It couldn’t be better.

Souleymane Kafando Tic Tac Livraison

The quote form looks really great, you and your team have done such a fantastic job in helping us and we really appreciate it!

I look forward to seeing the updates to the product when they come out.

Aaron Braintree Couriers

Andrew and the Creative Transmissions team helped MK Relocations out on an estimating system which needed experienced programming skills. We had been let down previously by someone else but Andrew managed to pick up the pieces and start the project from scratch again.

All our emails were replied to promptly and he set out a plan of action. All the stages of the project were completed on time. He was very customer focused and when we asked for amendments regarding presentation he was only to happy to help. He also helped us with the project after the project went live on the MK Relocations webiste. This support has helped us greatly.

In summary we would not hesitate to use Creative Transmissions again. HVery professional and provided excellent value for money. We have already recommended a business owner to use this service. Thank you so much.

Yves MK Relocations

Tried working with at least 5 developers before I found Andrew. Will not be needing to work with anyone else. Amazing developer, takes pride in his work and always went beyond what was asked. Looking forward to working with him again.

Stephen Lawless

Prompt efficient service, Thanks.

Jay Stewart 1st Logistics