Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Onfleet

Last mile delivery software

CategoryOther
Authenticationcustom
Version0.2.0
Published scopes0 published scopes
Last updatedSeptember 21, 2026

Overview

Connect Onfleet with Flows360

Last mile delivery software

Use the Onfleet connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 33 actions and 18 triggers.

Available actions

  • Create Recipient
  • Update Recipient
  • Get Recipient
  • Create Task
  • Delete Task
  • Force Complete Task
  • Clone Task
  • Update Task
  • Plus 25 additional declared actions.

Available triggers

  • Task Arrival
  • Task Assigned
  • Task Cloned
  • Task Completed
  • Task Created
  • Task Delayed
  • Plus 12 additional declared triggers.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Onfleet
  • Package: @activepieces/piece-onfleet@0.2.0
  • Exact artifact digest: sha256:145a89289c1b17b5a9803d7ae830af60cd7c48cc7d6720a84f9cf3e8f49f320e
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

SECRET TEXT. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Create Recipient (create_recipient), Creates a recipient Classification: read.
  • Update Recipient (update_recipient), Updates a recipient Classification: read.
  • Get Recipient (get_recipient), Gets a single recipient Classification: read.
  • Create Task (create_task), Creates a task Classification: read.
  • Delete Task (delete_task), Deletes a task Classification: read.
  • Force Complete Task (complete_task), Force completes a task Classification: read.
  • Clone Task (clone_task), Clones a task Classification: read.
  • Update Task (update_task), Updates a task Classification: read.
  • Get Task (get_task), Get a specific task Classification: read.
  • Get Tasks (get_tasks), Get many task Classification: read.
  • Create Destination (create_destination), Create a new destination Classification: read.
  • Get Destination (get_destination), Get a specific destination Classification: read.
  • Get Hubs (get_hubs), Get many hubs Classification: read.
  • Create Hub (create_hub), Create a new hub Classification: read.
  • Update Hub (update_hub), Update an existing hub Classification: read.
  • Get Organization (get_organization), Get your organization details Classification: read.
  • Get Delegatee Details (get_delegatee_details), Get details of a connected organization Classification: read.
  • Create Administrator (create_admin), Create a new administrator Classification: read.
  • Update Administrator (update_admin), Update an existing administrator Classification: read.
  • Get Administrators (get_admins), Get many administrators Classification: read.
  • Delete Administrator (delete_admin), Delete an existing administrator Classification: read.
  • Create Worker (create_worker), Create a new worker Classification: read.
  • Delete Worker (delete_worker), Delete an existing worker Classification: read.
  • Get Worker (get_worker), Get an existing worker's details Classification: read.
  • Get Worker Schedule (get_worker_schedule), Get an existing worker's schedule Classification: read.
  • Update Worker (update_worker), Update an existing worker Classification: read.
  • Create Team (create_team), Create a new team Classification: read.
  • Delete Team (delete_team), Delete an existing team Classification: read.
  • Get Team (get_team), Gets an existing team Classification: read.
  • Get Teams (get_teams), Gets many existing team Classification: read.
  • Update Team (update_team), Update an existing team Classification: read.
  • Get Container (get_container), Get a specific container Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • Task Arrival, webhook.
  • Task Assigned, webhook.
  • Task Cloned, webhook.
  • Task Completed, webhook.
  • Task Created, webhook.
  • Task Delayed, webhook.
  • Task Deleted, webhook.
  • Task ETA, webhook.
  • Task Failed, webhook.
  • Task Started, webhook.
  • Task Unassigned, webhook.
  • Task Updated, webhook.
  • Worker Created, webhook.
  • Worker Deleted, webhook.
  • Worker Duty Change, webhook.
  • Auto Dispatch Completed, webhook.
  • SMS Recipient Opt Out, webhook.
  • SMS Recipient Response Missed, webhook.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects51
Supported actions33
Triggers18

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • API Key Required · protected credential

Supported objects

ObjectReadWriteNotes
Create Recipient Yes No Creates a recipient
Update Recipient Yes No Updates a recipient
Get Recipient Yes No Gets a single recipient
Create Task Yes No Creates a task
Delete Task Yes No Deletes a task
Force Complete Task Yes No Force completes a task
Clone Task Yes No Clones a task
Update Task Yes No Updates a task
Get Task Yes No Get a specific task
Get Tasks Yes No Get many task
Create Destination Yes No Create a new destination
Get Destination Yes No Get a specific destination
Get Hubs Yes No Get many hubs
Create Hub Yes No Create a new hub
Update Hub Yes No Update an existing hub
Get Organization Yes No Get your organization details
Get Delegatee Details Yes No Get details of a connected organization
Create Administrator Yes No Create a new administrator
Update Administrator Yes No Update an existing administrator
Get Administrators Yes No Get many administrators
Delete Administrator Yes No Delete an existing administrator
Create Worker Yes No Create a new worker
Delete Worker Yes No Delete an existing worker
Get Worker Yes No Get an existing worker's details
Get Worker Schedule Yes No Get an existing worker's schedule
Update Worker Yes No Update an existing worker
Create Team Yes No Create a new team
Delete Team Yes No Delete an existing team
Get Team Yes No Gets an existing team
Get Teams Yes No Gets many existing team
Update Team Yes No Update an existing team
Get Container Yes No Get a specific container
Custom API Call Yes No Make a custom API call to a specific endpoint
Task Arrival Yes No webhook trigger declared by the pinned package.
Task Assigned Yes No webhook trigger declared by the pinned package.
Task Cloned Yes No webhook trigger declared by the pinned package.
Task Completed Yes No webhook trigger declared by the pinned package.
Task Created Yes No webhook trigger declared by the pinned package.
Task Delayed Yes No webhook trigger declared by the pinned package.
Task Deleted Yes No webhook trigger declared by the pinned package.
Task ETA Yes No webhook trigger declared by the pinned package.
Task Failed Yes No webhook trigger declared by the pinned package.
Task Started Yes No webhook trigger declared by the pinned package.
Task Unassigned Yes No webhook trigger declared by the pinned package.
Task Updated Yes No webhook trigger declared by the pinned package.
Worker Created Yes No webhook trigger declared by the pinned package.
Worker Deleted Yes No webhook trigger declared by the pinned package.
Worker Duty Change Yes No webhook trigger declared by the pinned package.
Auto Dispatch Completed Yes No webhook trigger declared by the pinned package.
SMS Recipient Opt Out Yes No webhook trigger declared by the pinned package.
SMS Recipient Response Missed Yes No webhook trigger declared by the pinned package.

Supported actions

Create Recipient · Read

Creates a recipient

create_recipient · Risk: low · Retry: safe

Inputs

  • name · string · Required, The recipient's full name
  • phone · string · Required, A unique, valid phone number as per the organization's country if there's no leading + sign. If a phone number has a leading + sign, it will disregard the organization's country setting.
  • notes · string · Optional
  • skipSMSNotifications · boolean · Optional
  • skipPhoneNumberValidation · boolean · Optional
  • useLongCodeForText · boolean · Optional, Checking this option will default the Onfleet system to use a toll-free long code number for SMS communication.
Update Recipient · Read

Updates a recipient

update_recipient · Risk: low · Retry: safe

Inputs

  • id · string · Required, The ID of the recipient you want to update
  • name · string · Optional, The recipient's full name
  • notes · string · Optional
  • skipSMSNotifications · boolean · Optional
Get Recipient · Read

Gets a single recipient

get_recipient · Risk: low · Retry: safe

Inputs

  • id · string · Required, The recipient's ID
Create Task · Read

Creates a task

create_task · Risk: low · Retry: safe

Inputs

  • merchant · string · Optional, ID of the organization that will be displayed on the task
  • executor · string · Optional, ID of the organization that will be executing the task
  • destination · object · Required, The task destination
  • unparsedDestination · boolean · Required, Check this box if the destination is a single unparsed string
  • recipient · object · Required, The task destination
  • useRecipientID · boolean · Required, Check this box if you want to use an ID for the recipient
  • completeAfter · string · Optional, The earliest time the task should be completed
  • completeBefore · string · Optional, The latest time the task should be completed
  • pickupTask · boolean · Optional, Whether the task is pickup
  • quantity · number · Optional, The number of units to be dropped off
  • recipientName · string · Optional, Override the recipient name for this task only
  • recipientNotes · string · Optional, Override the recipient notes for this task only
  • recipientSkipSMSNotifications · boolean · Optional, Override the recipient skip SMS option for this task only
  • serviceTime · number · Optional, The number of minutes to be spent by the worker on arrival at this task's destination
Delete Task · Read

Deletes a task

delete_task · Risk: low · Retry: safe

Inputs

  • task · string · Required, The ID of the task you want to delete
Force Complete Task · Read

Force completes a task

complete_task · Risk: low · Retry: safe

Inputs

  • task · string · Required, The ID of the task you want to complete
  • success · boolean · Required, Whether to complete the task as a success or not
  • notes · string · Optional
Clone Task · Read

Clones a task

clone_task · Risk: low · Retry: safe

Inputs

  • task · string · Required, ID of the task you want to clone
Update Task · Read

Updates a task

update_task · Risk: low · Retry: safe

Inputs

  • task · string · Required, ID of the task you want to update
  • merchant · string · Optional, ID of the organization that will be displayed on the task
  • executor · string · Optional, ID of the organization that will be executing the task
  • completeAfter · string · Optional, The earliest time the task should be completed
  • completeBefore · string · Optional, The latest time the task should be completed
  • pickupTask · boolean · Optional, Whether the task is pickup
  • quantity · number · Optional, The number of units to be dropped off
  • serviceTime · number · Optional, The number of minutes to be spent by the worker on arrival at this task's destination
Get Task · Read

Get a specific task

get_task · Risk: low · Retry: safe

Inputs

  • task · string · Required, The ID of the task you want to delete
Get Tasks · Read

Get many task

get_tasks · Risk: low · Retry: safe

Inputs

  • from · string · Required
  • to · string · Optional
  • state · array · Optional
Create Destination · Read

Create a new destination

create_destination · Risk: low · Retry: safe

Inputs

  • destination · object · Required, The task destination
  • unparsedDestination · boolean · Required, Check this box if the destination is a single unparsed string
  • notes · string · Optional
Get Destination · Read

Get a specific destination

get_destination · Risk: low · Retry: safe

Inputs

  • destination · string · Required, The ID of the destination you want to delete
Get Hubs · Read

Get many hubs

get_hubs · Risk: low · Retry: safe

Create Hub · Read

Create a new hub

create_hub · Risk: low · Retry: safe

Inputs

  • name · string · Required, Name of the hub
  • destination · object · Required, The task destination
  • unparsedDestination · boolean · Required, Check this box if the destination is a single unparsed string
  • teams · array · Optional
Update Hub · Read

Update an existing hub

update_hub · Risk: low · Retry: safe

Inputs

  • hub · string · Required
  • name · string · Optional, Name of the hub
  • teams · array · Optional
Get Organization · Read

Get your organization details

get_organization · Risk: low · Retry: safe

Get Delegatee Details · Read

Get details of a connected organization

get_delegatee_details · Risk: low · Retry: safe

Inputs

  • organization · string · Required, ID of the connected organization
Create Administrator · Read

Create a new administrator

create_admin · Risk: low · Retry: safe

Inputs

  • name · string · Required, Full name
  • email · string · Required
  • phone · string · Optional
  • isReadOnly · boolean · Optional, Whether this administrator can perform write operations.
Update Administrator · Read

Update an existing administrator

update_admin · Risk: low · Retry: safe

Inputs

  • admin · string · Required
  • name · string · Optional, Full name
Get Administrators · Read

Get many administrators

get_admins · Risk: low · Retry: safe

Delete Administrator · Read

Delete an existing administrator

delete_admin · Risk: low · Retry: safe

Inputs

  • admin · string · Required
Create Worker · Read

Create a new worker

create_worker · Risk: low · Retry: safe

Inputs

  • name · string · Required, Name of the worker
  • phone · string · Required
  • teams · array · Required
  • capacity · number · Optional, The maximum number of units this worker can carry
  • displayName · string · Optional
Delete Worker · Read

Delete an existing worker

delete_worker · Risk: low · Retry: safe

Inputs

  • worker · string · Required
Get Worker · Read

Get an existing worker's details

get_worker · Risk: low · Retry: safe

Inputs

  • worker · string · Required
Get Worker Schedule · Read

Get an existing worker's schedule

get_worker_schedule · Risk: low · Retry: safe

Inputs

  • worker · string · Required
Update Worker · Read

Update an existing worker

update_worker · Risk: low · Retry: safe

Inputs

  • worker · string · Required
  • name · string · Optional, Name of the worker
  • teams · array · Optional
  • capacity · number · Optional, The maximum number of units this worker can carry
  • displayName · string · Optional
Create Team · Read

Create a new team

create_team · Risk: low · Retry: safe

Inputs

  • name · string · Required, Name of the team
  • workers · array · Required
  • managers · array · Required
  • hub · string · Optional
  • enableSelfAssignment · boolean · Optional, Allows Drivers to Self Assign Tasks that are in the Team unassigned container.
Delete Team · Read

Delete an existing team

delete_team · Risk: low · Retry: safe

Inputs

  • team · string · Required
Get Team · Read

Gets an existing team

get_team · Risk: low · Retry: safe

Inputs

  • team · string · Required
Get Teams · Read

Gets many existing team

get_teams · Risk: low · Retry: safe

Update Team · Read

Update an existing team

update_team · Risk: low · Retry: safe

Inputs

  • team · string · Required
  • name · string · Optional, Name of the team
  • workers · array · Optional
  • managers · array · Optional
  • hub · string · Optional
  • enableSelfAssignment · boolean · Optional, Allows Drivers to Self Assign Tasks that are in the Team unassigned container.
Get Container · Read

Get a specific container

get_container · Risk: low · Retry: safe

Inputs

  • containerType · string · Required
  • containerId · string · Required
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Triggers

Task Arrival · Webhook

Triggers when a task worker arriving at or closer than threshold value provided, in meters

Task Assigned · Webhook

Triggers when a task is assigned

Task Cloned · Webhook

Triggers when a task is cloned

Task Completed · Webhook

Triggers when a task is completed

Task Created · Webhook

Triggers when a task is created

Task Delayed · Webhook

Triggers when a task is delayed

Task Deleted · Webhook

Triggers when a task is deleted

Task ETA · Webhook

Triggers when a task worker ETA less than or equal to threshold value provided, in seconds

Task Failed · Webhook

Triggers when a task has failed

Task Started · Webhook

Triggers when a task is started

Task Unassigned · Webhook

Triggers when a task is unassigned

Task Updated · Webhook

Triggers when a task is updated

Worker Created · Webhook

Triggers when a worker is created

Worker Deleted · Webhook

Triggers when a worker is deleted

Worker Duty Change · Webhook

Triggers when a worker status changes

Auto Dispatch Completed · Webhook

Triggers when team auto-dispatch calculation is completed

SMS Recipient Opt Out · Webhook

Triggers when a recipient opts out of SMS notifications

SMS Recipient Response Missed · Webhook

Triggers when a recipient responds to a notification via SMS, but the organization is unable to handle it at that time

Setup

Setup

  1. Add the Onfleet connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • No provider credential fields are declared by the pinned package.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-onfleet@0.2.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 33 actions and 18 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Onfleet connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-onfleet@0.2.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com