---
title: Webhooks and API Keys
slug: webhooks-and-api-keys
docTags: 
createdAt: 2026-01-15T13:08:17.092Z
---

Integrating your platform with the wider digital ecosystem is essential for automation and growth. The **Webhooks & API Keys **section serves as the technical "communication hub" of your Hyperzod platform. It allows you to connect your business to third-party tools such as marketing automation, accounting software, or CRM systems, ensuring that data flows seamlessly without manual intervention.

***

## Navigating to the Webhooks and API page

- On the Admin panel, navigate to the **Settings **section.

::Image[]{src="https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/Ewr-dm43Hi45-6SZ5n8Wp_image.png" size="50" width="503" height="604" position="center" darkWidth="503" darkHeight="604" showCaption="false"}

- Once in the settings section, under the **Platform Setup** section, click on **Webhooks & API Keys**.

![](https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/AuBhpW0AI-yXzstkgnNnL_image.png)

***

## Managing Webhooks

Webhooks are automated messages sent from Hyperzod to another app whenever a specific "event" happens (for example, a new order is created).

### How to Add a New Webhook

- Click the **Create New** button in the top right of the Webhooks table.

![](https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/jH84wGUD0QbFiUYUFeJkH_image.png)

- **Enter Name:** Give your webhook a clear name.
- **Enter URL:** Paste the Destination URL provided by the external app you are connecting to.
- **Select Events:** Choose exactly which actions should trigger this message. You can select multiple events, such as: **Order Ready:** Triggers when a merchant marks an order as ready.
- Click **Save**.

![](https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/bT0rHpmv2mcRunu7We7N7_image.png)

***

## Managing Existing Webhooks

- **Status Toggle:** Use the status switch to quickly enable or disable a webhook without deleting it.
- **Edit/Delete:** Use the icons under the "Action" column to update your URL or permanently remove a webhook.

![](https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/ZGA4UwgZJa0itb5U7mVmj_image.png)

### Webhook Logs

- Click the **Webhook Logs** button at the top to see a history of messages sent and check for any errors.

![](https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/Fe-ugtbOtY6X_jondoCgE_image.png)

***

## How to Generate a New API Key

An **API Key **is essentially a "digital key" or a secure password that allows two different software programs to talk to each other.

- Switch to the **Api Keys** tab on the screen.
- Click on **Create New**.

![](https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/LZnzFT3Sw0dIIwCrvxOeK_image.png)

- **Name your Key:** Give it a name that describes what it’s for (e.g., "Marketing App Key").
- Click **Save**.

::Image[]{src="https://api.archbee.com/api/optimize/A6k4A417O1V2DGm4H5kN0/mgI-qEOeu2Oy9LCf_Dd5X_image.png" size="90" width="713" height="369" position="center" darkWidth="713" darkHeight="369" showCaption="false"}