Skip to content
14-day free trial, no card9 languages176 business types · 50 apps
EN· USD
Try a live demoStart free trial

Integrations & REST API: how it works

Integrations & API lets other software work with your data. An API key lets another system read customers, leads, quotations, invoices, orders and products and create some of them, and webhooks tell another system the moment something happens here. Use it to connect accounting tools, automation services or your own app.

Lesson 2 of 9 · How it works

  • about 3 min
  • System → Integrations → Integrations & API

How it works

  1. «System → Integrations → Integrations & API» shows four figures at the top: «Active keys», «Endpoints», «Delivered (7 d)» and «Failed». Below are the panels «API keys», «Webhook endpoints» and «Event catalog».

  2. Press «Create key», give it a name that says where it is used, tick its scopes and, if you like, an expiry date. A scope is the right to read or to write one kind of record. Write includes read.

  3. The new key is shown once under «Your new API key». Copy it straight away: only a fingerprint of it is stored, so it cannot be shown again.

  4. The other system sends the key with every request. It can list and read customers, leads, quotations, invoices, orders and products, and it can create customers, leads, draft quotations and draft invoices.

  5. A lead created through the API triggers the same Messages The chat for staff inside the admin: direct messages, group chats and channels such as #general. Type @ and a name to mention a colleague. More words in the glossary as the website form. Quotations and invoices created through the API are always drafts with tax worked out as in the admin editor. The API never sends them or marks them paid.

  6. Each key row shows its scopes, who created it, the number of requests and the last use, with the badge «Active», «Expired» or «Revoked». «Revoke» stops a key immediately.

  7. «API docs» opens the full reference for a developer, and «Delivery log» opens the list of webhook posts.

Where to find it

Settings that change it

Checklist

Before you move on, check that you can:

  • Open System → Integrations → Integrations & API
  • System → Integrations → Integrations & API shows four figures at the top: Active keys, Endpoints, Delivered…
  • Press Create key, give it a name that says where it is used, tick its scopes and, if you like, an expiry date.
  • The new key is shown once under Your new API key.
  • The other system sends the key with every request.

Tips and common mistakes

  • Lost a key? It cannot be recovered. Revoke the old one and create a new one.
  • A request refused for a missing scope means the key was created without that right. Create a new key with the scope ticked.
  • A key may make 300 requests in a burst and then 5 per second. A system that asks faster is told to wait, and repeated refusals from one address can lead to a temporary ban.
  • Treat a key like a password. Give each connected system its own key, so you can revoke one without stopping the others.