Developers
Make API keys and webhooks so your own tools can work with FOM.
Settings → Developers is where you connect your own tools to FOM: a POS, a website, an accounting sheet or a script. API keys let a tool read and change your shop's data; webhooks tell it when something changes. For how to use them in code, see APIs & SDKs.
Before you start
Developers is on the web and needs the Owner or Manager role. API keys and webhooks need the API access add-on: see Add-ons.
Make an API key
Open Settings, choose the Developers tab and click API keys · Webhooks. Under API keys, click New key.
Give it a name that says where it's used, like POS sync. Under What it can do, tick only what the tool needs. You can only give it what you can do yourself.
Optionally set an expiry date, and allowed IP addresses (one per line) if the tool always runs from the same place.
Click Make key, then Copy it into your tool's settings. The key is shown only this once. Click I've saved it when done.
The list shows who made each key, when it was last used, and its status:
| Status | Meaning |
|---|---|
| Working | The key can be used. |
| Expired | Its expiry date has passed. |
| Revoked | Someone revoked it. |
| Not working | The person who made it left the shop or no longer has the permission. Make a new key. |
A key acts for the person who made it, so changes it makes show in the audit log as, for example, Ma Aye via API key 'POS sync'.
To stop a key, click Revoke. Tools using it stop working at once, and this can't be undone.
Add a webhook
Under Webhooks, click Add endpoint.
Enter the address your tool gave you (it starts with https://) and tick the events to send: New order, Order status changed, Low stock or Delivery changed.
Click Add endpoint, then copy the signing secret into your tool. It's shown only this once.
Click Send test to check that your tool answers.
On each endpoint you can:
- Deliveries: see what was sent in the last 30 days and how your tool answered. Resend sends one again.
- New secret: make a new signing secret if the old one leaked. Update your tool straight away.
- Turn off and Turn on: pause sending without removing the endpoint.
- Remove: stop sending and delete its delivery log.
If an endpoint fails 50 times in a row, FOM turns it off and notifies the Owner. Fix the tool, then click Turn on.