Integrations · How-to
Create and manage API keys for your own systems
Give a script or another system a key to work with this workspace, limit what it can reach, and replace or revoke it safely.
Check your plan
API keys are part of the Chain edition; see Plan & billing. Keys stop working the day a workspace leaves Chain. Only people with the workspace-settings permission, such as owners and admins, see Integrations › API and webhooks.
Create a key
Press “New key”. Under “What is it for”, name it after the system that will use it. Under “What it may reach”, tick only what it needs, module by module; “write” includes “read”. Leave everything unticked and the key gets your full access.
Copy it once
The key appears once, under “Your new key”. Copy it into the other system. It is not stored in Setvos and cannot be shown again: a lost key is replaced, not recovered.
Use it
The card shows the API address to send requests to, and “API quickstart” opens our guide. A key acts as you: it can do what your role allows and no more, and it stops working if you leave the workspace. It works on the workspace’s records only: it cannot change your account, make or replace keys, or reach anything outside the workspace. A key limited to some modules reaches only those — not search, and not the workspace’s settings.
Replace a key before it expires
A key stops working a year after it is issued and is marked “Expires soon” before then. Press the “Replace key” button (the circling arrows) beside it: the new key keeps the name, the reach and the allowed addresses and is valid for a year. Put it into the other system, then revoke the old one — or tick “Revoke the old key now (anything still using it stops working)”.
Revoke a key
Press the “Revoke” button (the bin) beside a key that is no longer needed or may have leaked. Setvos asks first: type the key’s name to confirm and press “Revoke”. The key stops working at once and cannot be brought back; it stays in the list marked “Revoked”, so its history is kept. If the other system still needs access, replace the key first.
Common questions
- What happens to a key when the person who created it leaves?
It stops working, because a key acts as the person it belongs to. Create a new key under someone who stays.
- Can I manage API keys on the phone?
Yes, under Developer, if you may change the workspace settings. A new or rotated key is shown once, with Copy, and revoking asks you to type it. A key acts as you. If your plan does not include API keys, the app says so up front.
Read next
Send Setvos events to your other systems with webhooks
Tell another system when something happens here — a contact added, a deal won, an invoice paid, a booking made — by posting it to an address you choose.
Set up roles and permissions
Use the four ready-made roles or build your own: choose what each role may do in every module and whose records it sees.
Choose a plan and pay for it, or change it later
Pick an edition, how many employees your licence covers and how long you prepay, see the price and subscribe — or change a licence that is already running.
More in Integrations
- Integrations: connect the services your business already uses
- Connect a service, test it and keep it working
- Take online payments by card or by bank transfer
- Send texts through your own SMS gateway
- Connect WhatsApp, Instagram and Messenger, and Viber
- Reach clients on Telegram with @Setvos_bot or your own bot
- Link your own Telegram to add leads and get notices in a chat
- Connect a shared mailbox to the Inbox
- Issue receipts through your Checkbox cash register (ПРРО)
- Connect Nova Poshta, Ukrposhta or Meest for deliveries
- Take orders from Rozetka, Prom.ua and OLX
- See your appointments in Google, Apple or Outlook Calendar
Open in Setvos
Signed in? This article is also in the Help menu of the app.
Still stuck?
Tell us what you were trying to do — we answer in chat, in six languages. Write to us
Move your bookings off paper, WhatsApp and three spreadsheets.
Bring your clients, services and past visits in from a spreadsheet or your old system’s export, with a preview before anything is written — and help in chat, in six languages, whenever you want it. Most studios are live the same day.