theme
OnFleet
FREE
By stefan.skliarov
Updated a year ago

OnFleet API Documentation

Real-time delivery management and analytics functionality.

Learn more about this API
POSTcloneTask
POSTcompleteTask
POSTcreateAdministrator
POSTcreateDestination
POSTcreateDestinationFromRaw
POSTcreateRecipient
POSTcreateTask
POSTcreateTeam
POSTcreateWebhook
POSTcreateWorker
POSTdeleteAdministrator
POSTdeleteTask
POSTdeleteTeam
POSTdeleteWebhook
POSTdeleteWorker
POSTfindRecipientByName
POSTfindRecipientByPhone
POSTgetDelegateeDetails
POSTgetOrganizationDetails
POSTgetSingleDestination
POSTgetSingleRecipient
POSTgetSingleTask
POSTgetSingleTaskByShortId
POSTgetSingleTeam
POSTgetSingleWorker
POSTgetWorkersByLocation
POSTinsertTasksAtIndex
POSTlistAdministrators
POSTlistHubs
POSTlistTasks
POSTlistTeams
POSTlistWebhooks
POSTlistWorkers
POSTtestAuth
POSTupdateAdministrator
POSTupdateRecipient
POSTupdateTask
POSTupdateTasks
POSTupdateTeam
POSTupdateWorker
POSTwebhookEvent
POSTcreateWebhook

Webhooks make it possible for your application to be notified of important system events, as soon as these take place within Onfleet.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
apiKeyCREDENTIALS
REQUIREDApi key obtained from OnFleet
triggerNUMBER
REQUIREDThe number corresponding to the trigger condition on which the webhook should fire: http://docs.onfleet.com/docs/webhooks
urlSTRING
REQUIREDThe URL that Onfleet should issue a request against as soon as the trigger condition is met.
Optional Parameters
thresholdNUMBER
OPTIONALFor trigger 1, the time threshold in seconds; for trigger 2, the distance threshold in meters.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication