Webhooks are part of our API and are a simple way to get events in our system—such as a vehicle’s location or a vehicle entering a landmark—pushed to your system as they occur. We push data by making an HTTP POST to a URL that you have configured with us for an event.
Manage Webhooks
The available webhooks are listed in the Webhook Manager within the portal (Account menu > Manage Webhooks).
| Webhook | Description |
|---|---|
| Location | When a vehicle reports its location |
| Speed | When a vehicle reports speed >= X mph |
| Posted Speed | When a vehilce reports inst speed >= X mph above speed limit |
| Heartbeat | When a vehicle reports a heartbeat (usually once a day) |
| Trip Complete | When a movement trip completes |
| Ignition On | When a vehicle's ignition turns on |
| Ignition Off | When a vehicle's ignition turns off |
| Landmark Enter | When a vehicle enters a landmark |
| Landmark Leave | When a vehicle leaves a landmark |
| Lanmdark Change | When a vehicle enters or leaves a landmark |
| Idle | When a vehicle idles |
| Temperature | When temperature is reported |
| DVIR | When a DVIR event is received |
| Driver Assignment | When a driver is assigned to a vehicle |
You can configure a new webhook through the portal interface or through an API call.
To configure a webhook through the portal:
- From the portal, click the Account menu, click Manage Webhooks, and click Open.
The Webhook Manager opens in a new browser tab.
- Click the green plus sign (
) next to the webhook you want to create.
The Create Webhook window opens.
- Enter the following properties:
- URL: Enter the URL that you want to consume the feed.
- Name: Enter a name used to refer to the webhook.
- Content Type: Choose from json (application/json) or form (application/x-www-form-urlencoded).
- Example HTTP Headers: Based on the selected content type, an example HTTP Header is provided for you.
- Example POST body: Based on the selected content type, an example POST Body is provided for you.
- Click Add Webhook.
The webhook is assigned an ID and appears in the Webhooks grid. Additional information is provided for Status, Queue Depth, Total Messages, and Demo. Demo allows you to trigger a test event to view a live feed of webhook messages.
Manage Third Party Integrations
In addition to webhooks, the portal can also support third-party integrations with several providers. Some providers require a signed release form for permission to transfer location data.
| Provider | Software Type | Requirements |
|---|---|---|
| ServiceMax | Field Service Management | Requires a Salesforce login for authorization. |
| Service Titan | Business Management | Requires an API Key. |
| Fleetio | Fleet Management | Requires an API Key and Account Id. Choose whether or not to Update Odometer and/or Diagnostic Trouble Codes. |
| Asana | Task Management | Requires an API Key and Vehicle Attribute. |
| Agile Fleet | Fuel Management | Requires an API Key and Vehicle Attribute |
Configuring ServiceTitan integration:
You must complete a ServiceTitan API Authorization Form and send to your ServiceTitan representative, who will then provide the required API key.
For steps on integrating ServiceTitan, see: ServiceTitan Integration Update.
Configuring Fleetio integration:
Please refer to the About Fleetio Integration article for detailed instructions.
Configuring Asana integration:
Before starting, ensure the vehicles’ VINs in the GPS portal matches the VINs in the Asana system.
- From the portal, click the Account menu, click Manage Webhooks, and click Open.
The Webhook Manager opens in a new browser tab.
- Under Available Integrations, click the green plus sign () next to Asana.
The Asana integration window appears.
- Enter the required properties for the integration:
- API Key: Enter API key provided by Asana.
- Vehicle Attribute: Choose the attribute to integrate.
- Click Add.
The third party integration(s) are assigned an ID and appears in the 3rd Party Integrations grid. There will be a separate ID for each integration type (e.g., multiple attributes). Additional information is provided for Status, Queue Depth, and Total Messages. An option to delete the integration(s) is also available.