Developer API and webhooks
For technical partners: API keys, apps you approve, a REST API and signed webhooks to connect payroll, reporting or custom tools.
Updated November 20, 2026
What it does
For technical partners: API keys, apps you approve, a REST API and signed webhooks to connect payroll, reporting or custom tools.
Turn it on
- Open Modules in the dashboard menu.
- Find Developer API and webhooks in the list and switch it on.
If your plan does not include this module, its card has no switch. Click Request this module and our team will get back to you. See Turn modules on and off.
Use it day to day
- Open Developers and click Create API key. Choose only the scopes it needs and copy the key: it is shown once.
- Give the key to your developer. Keep it private, like a password.
- Click Add a webhook endpoint to get live updates, such as new orders.
- Open the delivery log of an endpoint to see each attempt of the last 30 days, and Retry failed ones.
Connect an app
Some tools connect without a key: they send you to FoxOS to approve them.
- Sign in as the owner. FoxOS shows Allow (app) to access your restaurant? with the access it asks for, which locations, and the website it sends you back to.
- Pick the location (or all locations) and click Allow only if you trust the company. Apps marked Reviewed by FoxOS were checked by our team. For any other app, FoxOS does not review what the company built.
- The app appears under Developers, Installed apps. Click Uninstall to cut its access at once: its tokens stop working and it gets no more webhooks.
Find an app in the App directory
Open App directory in the dashboard menu to browse apps that FoxOS reviewed.
- Search by name or filter by category, then click View to see what the app does, who made it, and the access it asks for in plain language.
- Click Install. The app takes you back to FoxOS to ask for your permission, exactly as in the steps above. Nothing is shared before you click Allow.
- If an app changes the access it asks for, it goes back to review and leaves the directory until our team approves it again. Apps you already installed keep what you approved.
Practice in a sandbox
A sandbox is a practice copy of a restaurant for the person building your connection.
- Open Developers and click Create a sandbox. You can have up to three.
- FoxOS fills it with demo orders, guests and staff. Open it from the list and create API keys there.
- A sandbox never takes real payments, never sends real email or text messages, and is never billed. Its keys are labelled Sandbox.
- Click Reset for fresh demo data, or Delete to remove it for good. Your real restaurant is never touched.
Submit your own app for review
If you build an app for other restaurants, register it under Developers, Apps in your real workspace, then click Submit for review.
- Add a category, an install link, a support link, a privacy policy link and up to five screenshots.
- Our team approves it or tells you why not. You see the reason next to the app, and you can fix it and submit again.
- Changing the scopes or redirect URIs of an approved app sends it back to review.
Common questions
Is this for me?
Only if someone technical is building a connection for you. Most restaurants never need it.
Can an app see all my locations?
Only if you chose all locations when you approved it. Apps that read guests or loyalty need all locations, because guests are shared by your locations.
A key was shared by mistake.
Use Revoke key on the same page, then create a new one. Anything using the old key stops working.
Was this helpful?
Related articles
- Turn modules on and offUse the Modules page to choose what your restaurant uses.
- CoreCore is the base of FoxOS.
- Alerts and push notificationsGet a notification on your phone for new orders and for problems, such as a printer that is offline.
- DaypartsShow different menus at breakfast, lunch and dinner, automatically.