Metadata is optional, user-defined data that can be set for any dispatcher, driver, destination, task, or recipient via the Onfleet API. This can be a useful extension beyond the available Onfleet fields to fit your use-case.


If the metadata visibility is set to 'dashboard', then it will be visible to dispatchers from the dashboard for any tasks, recipients, or drivers where it is applied.

Dispatchers can copy metadata objects and arrays by clicking on the copy symbol in the upper right-hand corner of the object/array.

Note: new metadata fields cannot be created from within the dashboard.

Editing metadata

Boolean, string, and number metadata types can be edited directly from the dashboard by dispatchers, however array and object types can only be viewed. 

To edit metadata, click the 'Edit' button in the lower left hand corner.