API keys and webhooks

Make an API key that acts as one of your roles, send a webhook when a row changes, and follow every delivery in the log.

What's in this video

1. The OmniSchema API lets your other systems read your data, and add to it. It's on the Growth and Enterprise plans. In Governance, click API keys.
2. At the top is how many calls your keys have made this month. All your keys share the same monthly allowance.
3. To make a key, give it a clear name, like Website enquiries. Then choose the role it acts as. A key sees exactly what someone in that role sees, and nothing more.
4. What it can do: Read only, or Read and write, which can also add and change rows in your Operations lists. Pick Read only unless it really needs to write. You can also set a date when it stops working.
5. Click Create key. The key is shown once, and only once, so copy it straight into the system that needs it. We've hidden it in this video.
6. Click I've saved it. The key is now under Your keys, with its role, when it was last used, and how many calls it made this month.
7. If a key is lost, or not needed any more, click Revoke. You're asked to be sure, because anything using it stops straight away. We'll keep this one.
8. Webhooks work the other way round: OmniSchema tells your system the moment something changes. They're set up on each list. Open Databases, and choose your database.
9. Click the list, here Work Orders, and open Connections and Feeds.
10. Tick when to send: when a row is added, changed or deleted. Paste the address your other system gave you, and click Add Connection.
11. A signing code is shown once. Your system uses it to check that each message really came from OmniSchema. We've hidden it here too.
12. Click Send a test event, then Deliveries. The delivery log shows every message, whether it was delivered, and if not, when it will try again. This address is only an example, so it can't be delivered.
13. Developers will find everything else on our Developers page: their first call, reading and adding data, webhooks, and limits.