Zudo Works

How to create an API key and a webhook

Let another system read or write your data (API key), or be told automatically when work orders and orders change (webhook). Owners only.

  1. Open Settings in the sidebar and press API keys & webhooks.
  2. In the API keys card press New key.
  3. Type a Name (for example Shop-floor dashboard), tick the Scopes the key may use (only what it needs), optionally set Expires (optional), and press Create key.
  4. Copy your new key: press the copy button and store the key somewhere safe — it is shown only this once. Press Done. The key is listed with its scopes, Last used and status; Revoke stops it at once.
  5. In the Webhooks card press Add endpoint.
  6. Type the Endpoint URL of the receiving system (must start with https://), an optional Description, and tick the Events to send (work order created, released, started, completed, closed, cancelled; sales order confirmed; purchase order received — or Everything).
  7. Press Add webhook. Signing secret shows the whsec_… secret once: copy it so the receiver can check the X-Zudo-Signature header, then press Done.
  8. Use Send test to check the connection; Pause / Resume and Delete are on the same row.
Step 3 — the New key dialog with a name, scopes and Create key
Step 3 — the New key dialog with a name, scopes and Create key
Step 4 — Copy your new key: the key shown once, with its copy button
Step 4 — Copy your new key: the key shown once, with its copy button
Step 7 — the Add endpoint dialog with URL, description, events and Add webhook
Step 7 — the Add endpoint dialog with URL, description, events and Add webhook
Tip: the API reference card further down the page shows how to call the API with the key (Authorization: Bearer <key>).

Last updated