Onfleet
On This Page
Onfleet is a Software-as-a-Service (SaaS) based SaaS-based delivery management platform that helps large and small businesses manage their last-mile deliveries. It provides features such as auto-dispatching, tracking of delivery drivers, optimal route suggestions, and automatic notifications and real-time tracking for recipients.
You can replicate the data from your Onfleet account to a Destination database or data warehouse using Hevo Pipelines. Hevo ingests the data objects in Full Load mode. Refer to section, Data Model for the list of supported objects.
Hevo uses the Onfleet JSON RESTful API to replicate the data present in your Onfleet account to the desired Destination database or data warehouse for scalable analysis.
Prerequisites
-
An active Onfleet account from which data is to be ingested exists.
-
The API key is available with the required permissions to provide Hevo access to your Onfleet account data.
-
You are logged in as an Account Owner or an Admin user to obtain the API key. Else, you can obtain it from your account owner or administrator.
-
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
Creating the API Key
You require an API key to authenticate Hevo on your Onfleet account. The API key does not expire and can be reused for all your Pipelines.
Note: You must log in as an Account Owner or an Admin user to perform these steps.
Perform the following steps to obtain the API key:
-
Log in to your Onfleet account.
-
In the top right corner, click Settings.
-
In the left navigation pane of the pop-up window, click API & Webhooks.
-
In the API Keys section, click +.
-
In the Add API key pop-up window, specify the following:
-
API Name: A unique name for your API key.
-
Access: The permissions granted to the API key. Select API key can access all data to allow Hevo to access your Onfleet account data.
-
-
Click Create Key.
-
In the API Keys section, double-click the API key.
-
In the Edit API key pop-up window, copy the API key and save it securely like any other password. Use this key while configuring your Hevo Pipeline.
Configuring Onfleet as a Source
Perform the following steps to configure Onfleet as the Source in your Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Click + CREATE PIPELINE in the Pipelines List View.
-
In the Select Source Type page, select Onfleet.
-
In the Configure your Onfleet Source page, specify the following:
-
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
-
API Key: The API key that you created in your Onfleet account.
-
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Data Replication
| For Teams Created | Default Ingestion Frequency | Minimum Ingestion Frequency | Maximum Ingestion Frequency | Custom Frequency Range (in Hrs) |
|---|---|---|---|---|
| Before Release 2.21 | 1 Hr | 1 Hr | 24 Hrs | 1-24 |
| After Release 2.21 | 6 Hrs | 30 Mins | 24 Hrs | 1-24 |
Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.
Hevo ingests all the objects in Full Load mode in each run of the Pipeline.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Administrators | Contains the details of all the users who can manage or configure your Onfleet account, such as adding or removing a team from the organization. |
| Hubs | Contains the details of the locations that serve as the start and end of routes for workers. |
| Organizations | Contains the details of the companies connected to an Onfleet account. |
| Teams | Contains the details of all various groups of workers and dispatchers in your Onfleet account. |
| Tasks | Contains the details of the pickup or delivery works assigned to workers in an organization. |
| Workers | Contains the details of the people who deliver the items to their respective destinations. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Source Considerations
- Rate Limit: Onfleet imposes a limit of 20 API calls per second per organization. If the limit is exceeded, Hevo defers the ingestion till the limits reset.
Limitations
- Hevo does not capture information for records deleted in the Source objects.
Revision History
Refer to the following table for the list of key updates made to this page:
| Date | Release | Description of Change |
|---|---|---|
| Mar-05-2024 | 2.21 | Updated the ingestion frequency table in the Data Replication section. |
| Nov-08-2022 | 2.01 | New document. |