Photo: Domenico Loia / Unsplash
⚙️ Settings

API key and webhooks for developers

Get your store’s API key for server-side integrations, and send real-time order events to your own server with webhooks.

⏱ 2 min read🖼 2 screenshotsUpdated:
🖥️ Open in dashboard/dashboard/settings?section=api

If you or your developer want to connect Vondera to your own systems — an ERP, an accounting tool, a warehouse system or a custom app — you have two tools. The API key lets your server read and update store data through the Vondera API. Webhooks do the opposite: Vondera calls your server the moment something happens, like a new or updated order.

Find them under Settings › Developer and Settings › Webhooks. API access is a Pro-plan feature.

Use your API key

1 Developer · 2 Api Key (copy button) · 3 Authorization header hint · 4 View Documentation
1 Developer · 2 Api Key (copy button) · 3 Authorization header hint · 4 View Documentation
Webhooks: each webhook with its trigger, method and status (endpoint URLs hidden)
Webhooks: each webhook with its trigger, method and status (endpoint URLs hidden)
  1. Open Settings › Developer.
  2. Copy your Api Key.
  3. Send it in the Authorization header of your server-side API requests.
  4. Click View Documentation for the available endpoints and request formats.
Api Key
Your store’s secret API key, with a copy button.
View Documentation
Opens the Vondera API documentation.
Revoke Api Key
Cancels the current key. Any integration using it stops working until you update it with a new key.
ℹ️ Good to knowTreat your API key like a password. Use it only on your server — never in website code, mobile apps or public code repositories. If it leaks, click Revoke Api Key right away.

Create a webhook

  1. Open Settings › Webhooks and click Create Webhook.
  2. Give it a clear title and choose the trigger event, for example orders.created or orders.updated.
  3. Enter your Endpoint URL — the address on your server that should receive the event.
  4. Save. The webhook appears in the list as Active.
Title
A name to recognize the webhook.
Trigger
The event that fires the webhook, for example orders.created (new order) or orders.updated (order changed).
Endpoint URL
Your server address that receives the event data.
Method
How the data is sent — POST.
Status
Whether the webhook is currently active.
Search webhooks
Find a webhook by name.
💡 TipApps you install from the App Store register their own webhooks here, titled App: <app name>. Leave them as they are — removing one can stop that app from working. To stop an app, uninstall or reconfigure it from the App Store.

Common questions

I don’t see the API key. Why?

API access is included in the Pro plan. Check your plan under Settings › Subscription.

What should my endpoint do when it receives a webhook?

Reply quickly with a success response, then do any heavy processing in the background. Make sure the URL is public and uses HTTPS.

Should I use the API or webhooks?

Use webhooks to react to events as they happen, and the API to fetch or change data when you need it. Most integrations use both.

Still need help?

Our support team is available 11 AM–7 PM (Egypt time), Saturday to Thursday.