Skip to content

Reports, team & securityConnect your own systems: API keys and webhooks

For developers: an API key lets another system read your catalogue; a webhook tells your system the moment an order is placed or stock changes.

  • 3 steps
  • 0:40 video
  • Store admin → Analytics → API Ecosystem
  • Advanced

Jump to a step

The video has no sound: the captions on screen explain each step, and every step is written out below with a picture.

  1. 1

    Make an API key

    Open API Ecosystem (the page is API & Webhooks). On API keys, press New key, say what it is for and press Create key. Copy it straight away — it is shown once.

    Step 1: Make an API key
  2. 2

    Register a webhook

    On Webhooks, press New webhook, choose When (an order is placed, stock changes…), type the address to deliver to and press Register webhook. Keep the signing secret it shows.

    Step 2: Register a webhook
  3. 3

    Test it

    Send a signed test delivery checks your system receives it. Pause or remove a webhook from its row.

    Step 3: Test it

Stuck on a step?

Book a short call and we will walk through it with your own shop on screen. Book a call