API keys, webhooks and Zapier

Connect other tools with API keys and webhooks

On the Chain edition another system can work with your workspace: an API key for requests into Setvos, and webhooks for news out of it. There is no Zapier app yet; the recipe below uses the webhook steps Zapier and Make already have.

  1. 01

    Create a key

    Open Integrations → API and webhooks and, under API keys, choose New key. Name it after the system that will use it and tick only what it needs: a key acts as you and can never do more than you can. Copy it straight away — it is shown once and not stored.

  2. 02

    Send requests

    Put the key in the Authorization header as “Bearer stv_live_…” and send requests to the API address shown on the same card. A key makes up to 300 requests a minute, and an address list on the key limits where it may be used from.

  3. 03

    Replace a key before it expires

    A key stops working a year after it is issued. Replace it on the card: the new key keeps the name, reach and address list, and the old one works until you revoke it, so you can switch the other system over first.

  4. 04

    Subscribe to events

    Under Webhooks choose New webhook, paste the address that should receive events and pick them: a contact added or changed, a deal moved to another stage or won, an invoice paid, an appointment booked or cancelled, an order paid. Each delivery is a POST with the event name in X-Setvos-Event and a signature in X-Setvos-Signature — sha256= and the HMAC of the body, made with the signing secret shown when you created the webhook.

  5. 05

    Build a Zapier or Make scenario

    In Zapier start a Zap with Webhooks by Zapier → Catch Hook; in Make, a scenario with Webhooks → Custom webhook. Paste the address they give you into a new webhook here, press Send a test and map the fields. To act on Setvos from a scenario, use Webhooks by Zapier → Custom Request or Make’s HTTP module, with your key in the Authorization header.

Common questions

Which edition has API keys?
Chain. A workspace that moves off Chain keeps its keys, but they stop working the same day.
What happens when a delivery fails?
It is tried again — six attempts in all, spread over most of a day. The webhook card lists recent deliveries, and a webhook that fails twenty times in a row is paused until you resume it.
Is there a Setvos app in the Zapier directory?
Not yet. The Catch Hook and Custom Request steps above do the same job today.

Where this lives in the product

Read next

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.