Skip to main content

Onfleet

Onfleet is a last-mile delivery management platform providing route optimization, driver dispatch, and real-time delivery tracking for fleets. The Onfleet REST API exposes teams, workers, administrators, hubs, containers, and delivery tasks, allowing you to ingest operational data and push new tasks, workers, and hubs into your Onfleet organization.

Onfleet icon

Power end-to-end data operations for your Onfleet API with Nexla. Our bi-directional Onfleet connector is purpose-built for Onfleet, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Onfleet or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Onfleet workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Before creating an Onfleet credential, you need an Onfleet API key. Onfleet authenticates every request using HTTP Basic authentication, where your API key is supplied as the username and the password is left blank.

To obtain your Onfleet API key, follow these steps:

  1. Sign in to your Onfleet Dashboard as an administrator.

  2. Open the Settings menu and navigate to the API section, where API keys are managed.

  3. Create a new API key for your integration, giving it a descriptive name (e.g., "Nexla Integration") so it can be identified and rotated independently of your other applications and environments.

  4. Copy the generated API key and store it securely. You will supply this value as the Username when creating your Nexla credential.

Each organization can create multiple API keys, so it is a good practice to use a dedicated key for Nexla. Because the API key grants access to your Onfleet organization's data, treat it as sensitive information and revoke it from the dashboard if it is ever compromised. For detailed information about authentication and available endpoints, refer to the Onfleet API Documentation.

Authenticate​

Credentials required​

FieldRequiredSecretDescription
UsernameYesNoUsername used to authenticate requests to the Onfleet API.
PasswordYesYesPassword used to authenticate requests to the Onfleet API.

Onfleet uses HTTP Basic authentication with your API key supplied as the Username. Per the Onfleet API documentation, the password is left blank. Enter your Onfleet API key in the Username field when creating your credential.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Onfleet API key in the Username field.

  4. Enter your Password if required by your configuration; per the Onfleet API documentation, this field is typically left blank because the API key alone authenticates the request.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Onfleet connector tile, then select the credential that will be used to connect to the Onfleet organization, and click Next; or, create a new Onfleet credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Onfleet endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Teams

Retrieve teams.

  • This endpoint template retrieves the teams defined in your Onfleet organization. Use it when you need team definitions for reporting, analysis, or downstream integration.

For detailed information about the response structure and available fields, see the Onfleet API Documentation.

[Rest API] List Administrators

Retrieve administrators.

  • This endpoint template retrieves the administrators in your Onfleet organization. Use it when you need administrator records for reporting, analysis, or downstream integration.

For detailed information about the response structure and available fields, see the Onfleet API Documentation.

[Rest API] List Workers

Retrieve workers.

  • This endpoint template retrieves the workers (drivers) in your Onfleet organization. Use it when you need worker records for reporting, analysis, or downstream integration.

For detailed information about the response structure and available fields, see the Onfleet API Documentation.

[Rest API] List Hubs

Retrieve hubs.

  • This endpoint template retrieves the hubs defined in your Onfleet organization. Use it when you need hub locations for reporting, analysis, or downstream integration.

For detailed information about the response structure and available fields, see the Onfleet API Documentation.

[Rest API] List Tasks

Retrieve tasks.

  • This endpoint template retrieves delivery tasks from your Onfleet organization. Results are paginated, and Nexla automatically follows the pagination to fetch subsequent pages of data.

For detailed information about the response structure, query parameters, and pagination, see the Onfleet API Documentation.

[Rest API] List Containers

Retrieve containers.

  • This endpoint template retrieves containers, which hold the ordered list of tasks assigned to a worker, team, or organization. Use it when you need task assignment ordering for reporting, analysis, or downstream integration.

For detailed information about the response structure and available fields, see the Onfleet API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Onfleet data sources can also be manually configured to ingest data from any valid Onfleet API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Onfleet data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Onfleet destination, and select the Send to Destination option from the menu. Select the Onfleet connector from the list of available destination connectors, then select the credential that will be used to connect to the Onfleet organization, and click Next; or, create a new Onfleet credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Onfleet endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Task

Create a new delivery task, optionally generating associated recipients and destinations automatically if provided as objects rather than IDs.

  • This endpoint sends each record from your Nexset as a JSON request body to create a new task in your Onfleet organization. Ensure your Nexset fields match the structure expected by the Onfleet task creation endpoint.

For detailed information about the request body format and available task properties, see the Onfleet API Documentation.

[Rest API] Create Worker

Create a new worker with a temporary password delivered via SMS, allowing them to set a permanent password upon first login to the mobile app.

  • This endpoint sends each record from your Nexset as a JSON request body to create a new worker in your Onfleet organization. Ensure your Nexset fields match the structure expected by the Onfleet worker creation endpoint.

For detailed information about the request body format and available worker properties, see the Onfleet API Documentation.

[Rest API] Update Task

Update fields on an existing task; only the fields provided are modified, with restrictions depending on the task's current state.

  • This endpoint sends each record from your Nexset as a JSON request body to update an existing task. You must supply the Task Id parameter identifying the Onfleet task to update.

For detailed information about the request body format and update restrictions, see the Onfleet API Documentation.

[Rest API] Create Hub

Create a new hub and optionally assign it to teams upon creation.

  • This endpoint sends each record from your Nexset as a JSON request body to create a new hub in your Onfleet organization. Ensure your Nexset fields match the structure expected by the Onfleet hub creation endpoint.

For detailed information about the request body format and available hub properties, see the Onfleet API Documentation.

Manual configuration​

Onfleet destinations can also be manually configured to send data to any valid Onfleet API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Onfleet APIs expect JSON format for create and update operations. For update operations, include the ID of the object to be updated in the endpoint configuration.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Onfleet endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Onfleet endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.