Start here

Connect Onfleet

Connecting Onfleet lets Winston look up your deliveries, drivers and teams and report on them. An Onfleet admin creates an API key, then you paste it into Winston. This page shows each screen.

Before you start

  • You need to be an Owner or Admin in Winston.
  • You need an Onfleet administrator to create the key. Only admins see API & Webhooks in Onfleet's settings.
The connection belongs to the Winston workspace, not only to you. Anyone in the workspace who asks Winston can have it read your Onfleet tasks, drivers and customers' delivery details. Winston still asks before it creates or changes anything; see Review and approve.

1. Create an API key in Onfleet

In the Onfleet dashboard, choose Settings at the bottom of the left menu, then API & Webhooks. Under API Keys, choose the +. In Add API key:

  • API Name: something you'll recognize, such as Winston.
  • Access: keep API key can access all data. The other choice, API key can only access tasks it creates, would hide all your existing deliveries from Winston.
Onfleet's Add API key dialog with an API Name field and the Access choice API key can access all data outlined, and Cancel and Create Key buttons
Add API key. Name it and keep Access on API key can access all data.

Choose Create Key and copy the key as soon as Onfleet shows it. Afterwards the list shows only its first and last two characters, as below.

Onfleet's settings open at API & Webhooks, outlined in the menu, with a key named Winston listed under API Keys and the + below the list outlined
Settings → API & Webhooks after creating the key. The Winston key is listed under API Keys.

2. Paste it into Winston

In Winston, open Settings → Connections, find the Onfleet card (under Delivery, or type "Onfleet" into the search box) and choose Connect.

The Connections screen in Winston searched for Onfleet, with the Onfleet card's Connect button outlined
Settings → Connections. Find Onfleet and choose Connect.

Paste the key into API Key and choose Connect. The dialog mentions a username and password, but the key is all it needs. Leave Base URL empty unless Onfleet has given you a different address; empty means https://onfleet.com/api/v2.

Winston's Onfleet dialog, badged Basic Auth, with a required API Key field and an optional Base URL field whose default is https://onfleet.com/api/v2
Paste the key into API Key. Leave Base URL empty.

3. Check it is connected

Winston checks the key with Onfleet and confirms with Onfleet is connected. Choose Done. The card then shows Connected.

The Onfleet card on the Connections screen with a green Connected badge, a pencil icon and a plug icon
The Onfleet card after connecting. The pencil replaces the key; the plug disconnects.

Then ask Winston a small read-only question in Chat, for example "Which Onfleet organization are you connected to, and what teams and drivers can you see?" Winston names the organization and lists its teams and drivers.

Replace the key

If the key is deleted or replaced in Onfleet, Winston's connection stops working. Choose the pencil on the Onfleet card, paste the new key into API Key and choose Save Changes. A field left blank keeps its current value.

Winston's Update Onfleet dialog with API Key showing (unchanged), an empty Base URL, and Cancel and Save Changes buttons
The pencil opens Update Onfleet. Paste a new key, or leave it blank to keep the current one.

Disconnect

To stop Winston using Onfleet, choose the plug icon on the Onfleet card and confirm Disconnect. This applies to the whole workspace.

The confirmation dialog titled Disconnect Onfleet?, with Cancel and a red Disconnect button
Disconnecting is workspace-wide. Confirm, and the card goes back to Connect.

Disconnecting removes the key from Winston but does not delete it in Onfleet. To make sure it can no longer be used, select it under API Keys in Onfleet and remove it with the −.

If something does not work

What you seeWhat to do
Winston says the key was refused (401 or Unauthorized)Part of the key was missed when copying, or the key was removed in Onfleet. Create a new one and paste it in with the pencil.
There is no API & Webhooks in Onfleet's settingsYou are not an Onfleet admin. Ask an admin to create the key.
Winston connects but finds no teams or driversThe Onfleet organization has none yet, or the key was created with "API key can only access tasks it creates". Check in Onfleet, or create a new key with "API key can access all data" and paste it in with the pencil.
Winston says it can't reach Onfleet after you filled in Base URLA blank field in the pencil's dialog keeps its current value, so you can't clear Base URL there. Disconnect, then connect again and leave Base URL empty, or enter https://onfleet.com/api/v2 with the pencil.

For other connections, see Connect your tools. Anything else, see Troubleshooting or contact Support from the dashboard.