Onfleet n8n integrationAutomate Onfleet with n8n.

Adds an administrator to the Onfleet organization and returns the created object. Administrators are the accounts that manage the organization, as opposed to the drivers who run the tasks.

• Admin ID: the ID of the admin object for lookup.
• Name and Email: the administrator's name and email address, in the name@email.com form suggested by the field.
• Read Only (Additional Fields): whether this administrator can perform write operations.

Removes an administrator from the organization. The call targets one account and returns nothing to reuse afterwards, so put it at the end of the branch.

• Admin ID: the ID of the admin object for lookup. It expects the identifier, not the person's name, so pass {{ $json.id }} from the operation that found the account rather than a value typed by hand.

Lists the administrators of the organization, so a workflow can audit them or pick one to notify.

• Admin ID: still marked as required on this operation, even though it returns a list. Fill it before running the node, or the execution stops on the empty field.
• Return All: enabled, n8n walks every page of admins; disabled, Limit caps how many come back.

Changes the details of an administrator who already exists. Only the fields you add are touched, the rest of the account is left alone.

• Admin ID: the ID of the admin object for lookup.
• Name (Update Fields) and Phone: the administrator's name and phone number.
• Read Only (Update Fields): whether this administrator can perform write operations.

Inserts tasks into a container, the ordered list of tasks attached to an organization, a team or a driver.

• Container Type and Container ID: organizations, teams or workers, then the object ID matching the container chosen.
• Insert Type and Index: -1 to append, 0 to prepend, 1 to insert at a specific index, and the index is the position where the tasks are inserted.
• Task IDs: the tasks that are going to be used.
• Consider Dependencies (Options): whether the target task's dependency family, parent and child tasks, follows into the assignment.

Reads a container and returns the tasks it currently holds, in their running order. Nothing is modified.

• Container Type: organizations, teams or workers, depending on whose list you want to look at.
• Container ID: the object ID according to the container chosen, often {{ $json.id }} from the worker or team operation just before.

Fully replaces the tasks of a container. What you send becomes the complete list, so anything missing from that list is no longer in the container.

• Container ID: the object ID according to the container chosen.
• Task IDs: the tasks that are going to be used, in the order you want them run.
• Consider Dependencies (Options): whether to include the target task's dependency family, parent and child tasks, in the resulting assignment.

Registers an address as a destination object, which tasks can then point to. Creating it once keeps the address consistent across every delivery that uses it.

• Unparsed Address: whether the address is specified in a single unparsed string, which decides how the other address fields are read.
• Destination Address, Number, Street, City, Country: the street address details, the number component that may also contain letters, the street name, the municipality and the country.
• Apartment (Additional Fields) and Address Notes: the suite or apartment number, and notes about the destination.

Fetches one destination and returns its stored address details.

• Destination ID: the ID of the destination object for lookup, usually taken from the task that references it with an expression like {{ $json.destination }}.

Declares a hub, the physical site a run starts from, and returns the created object. A hub carries an address of its own and can be attached to teams.

• Name: a name to identify the hub.
• Destination: the hub address, added through the Add Destination block, with Street, City, State and Country.
• Team Names or IDs (Additional Fields): the teams this hub is assigned to, chosen from the list or given as IDs through an expression.

Returns the hubs declared in the organization. No identifier is required here, which makes it the simplest way to get the full picture of your sites.

• Return All: enabled, every hub comes back page after page; disabled, Limit sets the maximum number of hubs returned.

Edits a hub that already exists, one field at a time. The fields you leave out keep their current value.

• Hub ID: the ID of the hub object for lookup.
• Name (Update Fields): a name to identify the hub, handy when depots are renamed after a reorganization.
• Destination (Update Fields) and Team Names or IDs: the hub address through Add Destination, and the teams the hub is assigned to.

Retrieves the details of the organization behind the API key. There is nothing to configure: the credential already says which organization is being read.

Reads the details of another organization you are connected with in Onfleet. Delegation is how two companies share deliveries, one sending the work, the other fulfilling it.

• Organization ID: the ID of the delegatees for lookup.

Saves a customer as a recipient, the object Onfleet attaches to tasks and sends SMS notifications to.

• Recipient Name: the recipient's complete name.
• Recipient Phone: a unique, valid phone number as per the organization's country if there is no leading + sign; with a leading + sign, the organization's country setting is disregarded.
• Skip Recipient SMS Notifications (Additional Fields): whether this recipient has requested to skip SMS notifications.

Looks up a single recipient. What makes this one different is that you choose how to search, which matters when the only thing you have is a phone number from an inbound message.

• Get By: the variable used for looking up a recipient, id, phone or name.
• Recipient ID, Name or Phone: the matching lookup value for the choice above.

Corrects the stored data of a recipient, which then applies to their future tasks.

• Recipient ID: the ID of the recipient object for lookup.
• Recipient Phone (Update Fields): the same phone rule as on creation, with the leading + sign deciding whether the organization's country is used.
• Recipient Notes (Update Fields): global notes for this recipient, which are not meant to be task-specific or destination-specific.

Duplicates an existing task and returns the copy. Useful when a delivery has to happen again with the same destination and recipient.

• Task ID: the ID of the task object for lookup.
• Complete After (Override Fields) and Complete Before: the earliest and latest time the copy should be completed, which is what you usually change on a clone.
• Include Dependencies (Override Fields), Include Barcodes and Include Metadata: what gets carried over to the copy.

Force-completes a task that has already been started, and records whether it ended well. This is the manual override, for the cases the driver app did not close properly.

• Task ID: the ID of the task object for lookup.
• Complete as a Success: whether the task's completion was successful, which is what separates a delivered parcel from a failed attempt in your reporting.
• Notes (Additional Fields): the completion notes.

This is the operation most Onfleet workflows are built around. It creates the delivery or pickup, with its destination, and returns the task object.

• Destination: the address, added through the Add Destination block, with Street, City and Country at minimum, or a single string when Unparsed Address is on.
• Complete After (Additional Fields) and Complete Before: the delivery window.
• Pick Up Task (Additional Fields): whether the task is a pickup rather than a drop-off.
• Service Time (Additional Fields): the minutes spent on arrival at the destination, used for route optimization.

Erases a task from Onfleet. It disappears from the driver's list, so this belongs to cancellations, not to failed attempts.

• Task ID: the ID of the task object for lookup, typically {{ $json.id }} carried from the node that identified the order.

Retrieves one task and its current state, which is the usual way to enrich an event before acting on it.

• Task ID: the ID of the task object for lookup, often {{ $json.id }} straight from the trigger.

Pages through the tasks of the organization, filtered by period and by state. This is the reporting operation of the node.

• Task ID: marked as required even on this list operation, so give it a value before running the node.
• Return All: enabled, every matching task comes back; disabled, Limit caps the number of tasks returned.
• From (Filters) and To: the start and end of the range, the end defaulting to the current time.
• State (Filters): 0 unassigned, 1 assigned, 2 active, 3 completed, or all.

Edits a task that already exists in Onfleet, without recreating it. Only the update fields you fill are applied.

• Task ID: the ID of the task object for lookup.
• Notes (Update Fields): the notes for the task, the field drivers read on their phone.
• Quantity (Update Fields) and Service Time: the number of units dropped off and the minutes spent on site, both used for route optimization.

Onfleet takes the tasks sitting in a team's unassigned container and hands them to the drivers currently on duty.

• Team ID: the ID of the team object for lookup, usually {{ $json.id }} carried over from an earlier node.
• Max Allowed Delay: the maximum time in minutes a task is allowed to run late.
• Max Number Of Tasks Per Route: the total number of tasks allowed on one route, so a single driver does not inherit the whole morning.
• Service Time: the default service time in minutes applied to tasks that carry none of their own.

A new team lands in the Onfleet organization with its drivers and its managing admins attached from the start.

• Name: a unique name for the team, so two depots never get confused.
• Worker Names or IDs: a list of workers, picked from the dropdown or passed as IDs through an expression, the n8n formula that reads a value off the incoming item.
• Administrator Names or IDs: the managing administrators who own the team.
• Self Assignment: in Additional Fields, decides whether drivers can self-assign tasks that sit in the team's unassigned container.

The team is removed from the Onfleet organization. Worth keeping this one in a workflow a human starts on purpose rather than on an automatic schedule.

• Team ID: the ID of the team object for lookup, better stored when the team is created than hunted for afterwards.

Point the node at one team ID and Onfleet returns that team's record, ready for the rest of the workflow to read with expressions.

• Team ID: the ID of the team object for lookup, often {{ $json.id }} coming out of a Get many teams step.

Every team in the organization comes back as a list, one item per team.

• Return All: on, n8n walks the API pages until the last team is in; off, it stops at Limit.
• Limit: the maximum number of teams to return, handy while you are still testing the workflow.

Estimated times for a team's upcoming tasks come back, along with the driver Onfleet would pick for the job.

• Team ID: the team being queried.
• Pick Up and Drop Off: in Filters, the two ends of the trip being estimated.
• Restricted Vehicle Types: vehicle types to ignore in the query, among CAR, MOTORCYCLE, BICYCLE and TRUCK.
• Service Time: the time in seconds a worker is expected to spend at the pickup location, the dropoff location, or both.

Changes land on an existing team. What you put in Update Fields is what changes, and nothing else gets sent.

• Team ID: the team being edited.
• Worker Names or IDs: the workers making up the team after the update.
• Hub Name or ID: the team's hub, chosen from the list or passed as an ID.
• Self Assignment: flips whether drivers can pick up the team's unassigned tasks themselves.

A driver gets an Onfleet account and joins a team in the same step, which is usually exactly what onboarding needs.

• Name: the worker's name.
• Phone: the worker's phone numbers.
• Team Names or IDs: one or more teams the worker is a member of.
• Capacity: in Additional Fields, the maximum number of units this worker can carry, used for route optimization.

Offboarding, in one node: the worker record leaves Onfleet. Logging the removal to a channel keeps dispatch from looking for someone who is gone.

• Worker ID: the ID of the worker object for lookup, not the display name.

One worker, one item back. The Options collection decides how much of the record travels with it.

• Worker ID: the ID of the worker object for lookup.
• Analytics: on, the response gets more detail, including basic worker duty events, traveled distance in meters and time analytics.
• Fields to Return: the list of fields to show when the full record is more than you need, such as onDuty, location or activeTask.

The worker list comes back filtered by where the drivers are right now, which is how you answer "who is near this address".

• Search by Location: whether to keep only the workers currently inside a target area.
• Longitude and Latitude: the coordinate pair at the center of that area.
• Radius: in Filters, the radius in meters of the spherical area to search. It defaults to 1000 when missing, and the maximum is 10000.
• Return All: on, every matching worker comes back; off, Limit caps the list.

Asking Onfleet for a driver's schedule gives the workflow something to reason with before it commits anyone to a job.

• Worker ID: the ID of the worker object for lookup, taken from a Get many workers step or stored in your own database.

Editing a driver record covers the day-to-day moves: a bigger load, a name fix, a transfer to another team.

• Worker ID: the driver being edited.
• Capacity: the maximum number of units this worker can carry, for route optimization purposes.
• Display Name: the name used in place of the real one in SMS notifications, on delivery tracking pages and across organization boundaries.
• Team Names or IDs: the teams the worker belongs to after the change.