Webhook Setup

Webhook Setup

Requirements

  1. Gearbox account with administration privileges

Restrictions

  1. After 10 failed attempts to deliver to an endpoint, the webhook will be disabled until a manual redeliver has succeeded
  2. Only HTTPS endpoints are supported, non-encrypted endpoints are not supported
  3. You must validate the endpoint you wish to receive events at before events will be delivered

Setup

  1. Navigate to 'Settings' -> 'Webhooks':


2. Click 'Add New Webhook'
3. Enter the required details and select the events you wish to subscribe to:



Note: you do not need multiple entries for the one endpoint, simply subscribe to the events you want that endpoint to receive.

4. Upon saving we will attempt to verify that the endpoint is owned by you. You can find more information about validating an endpoint and verifying a request came from Gearbox here

5. Once the endpoint has been validated you will receive events to the endpoint specified whenever one of the events is triggered.

6. You can view webhook events that have been sent by clicking 'Show History'




    • Related Articles

    • Webhook Verification

      Requirements Gearbox account with administration privileges Note: all code samples use Ruby Webhook Event A webhook event will contain the following header information: request['Content-Type'] = 'application/json' request['Accept'] = ...

    • Prestart Webhook

      Prestart Webhook prestart.created event { id: 1, # unique ID of the Prestart prestart_number: 100, fleet_number: 'PM-01', registration: 'ABC123', completed_by: 'Jane Doe', completed_at: '2023-12-11T14:17:33.283+11:00', created_at: ...

    • Purchase Order Webhook

      Purchase Order Webhook purchase_order.created event { id: 1 # unique ID of the purchase order, supplier: 'Trucks R Us', vehicle_group: 'Sydney', purchase_order_date: 2020-01-01, created_by: 'John Smith', approved: true, approved_user: 'Jane Doe', ...

    • How to log in to Gearbox

      We recommend you setup Two Factor Authentication (2FA) to protect your Gearbox account. If your company has setup 2FA, you need to complete additional authentication steps when you login to Gearbox. If you have any problems logging in, please contact ...

    • Gearbox Pricing

      Overview Gearbox and Prestart are charged on a monthly subscription based on the number of users and options selected in the software. The subscription is flexible, allowing you to add or remove modules and users at any time. To calculate pricing, ...