Developer and API access
Connect Upper Route Planner to your other systems — use the API token and webhooks to send work in automatically and push route events out to your apps.
Upper Route Planner can connect to the systems you already use, so work flows in automatically and route events flow back out to your other apps. Connecting Upper this way is for developers on your team and is available on the Optimize and Enterprise plans.
API integration is available on the Optimize and Enterprise plans. If you don't see these options in your account, talk to your account owner or contact support@upperinc.com about your plan.
Two ways to connect
There are two main building blocks for connecting Upper to your systems:
API token
Authenticate requests from your systems to Upper.
Webhooks
Have Upper notify your systems when route events happen.
Webhooks and the API token
Webhooks let Upper push events to a URL you control, so your systems can react automatically. You set them up in Settings > Webhooks.
Open Webhooks settings
From the left sidebar, go to Manage > Settings, then select Webhooks.
Add your webhook URL
Enter the Webhook URL where you want Upper to send events. Upper validates that it's a well-formed URL.
Copy your API token
The page shows your account's API Token. Use the copy control to copy it, then have your developer use it to authenticate requests. Keep this token private — treat it like a password.
The Webhooks page also keeps a history of past webhook deliveries, so your developer can confirm what Upper sent and when.
Tasks, contacts, and route creation can each be done by hand in the app or through the API. If your team has an existing system that already holds your jobs or customers, connecting it can keep Upper in sync without re-entering data.
Connecting an online store
If you sell through an online store, you can connect it to Upper from the Marketplace so orders come in as stops. Connecting a store typically asks for that store's own details — such as its store name, URL, and an API access token issued by the store — which you enter when you set up the connection.
Troubleshooting
Related
Configure user settings
Set Upper Route Planner's account defaults in User Settings — units, Optimize For, workload distribution, the default navigation map, vehicle type, and driving preferences.
Billing & subscription
Manage your Upper plan, payments, free trial, add-ons, and cancellation. Pricing is per user, billed through Stripe, with a 20% discount on annual plans.