> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepsmith.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Managing Webhooks

> Set up and manage webhooks from the DeepSmith platform

Webhooks are managed from **Settings > Webhooks** in your workspace.

## Creating a webhook

<Steps>
  <Step title="Open webhook settings">
    Go to **Settings > Webhooks** and click **Add Webhook**.
  </Step>

  <Step title="Configure the endpoint">
    Fill in the webhook details:

    * **URL** — The HTTPS endpoint that will receive deliveries
    * **Name** — A friendly label (e.g., "Production CMS Sync")
    * **Description** — What this webhook is used for (optional)
  </Step>

  <Step title="Choose events">
    Select one or more event types to subscribe to. See the [Event Catalog](/webhooks/event-catalog) for details on each event.
  </Step>

  <Step title="Save and copy the signing secret">
    After saving, your **signing secret** is displayed once. Copy it and store it securely — you'll need it to [verify signatures](/webhooks/security).
  </Step>
</Steps>

<Frame caption="Create a new webhook endpoint from Settings > Webhooks">
  <img src="https://mintcdn.com/onejam/ySwBQh4Wxzua98C6/images/webhooks/create-webhook.png?fit=max&auto=format&n=ySwBQh4Wxzua98C6&q=85&s=c27264dfa023050634885613cf594c08" alt="Create webhook form" width="2690" height="1450" data-path="images/webhooks/create-webhook.png" />
</Frame>

<Warning>
  The signing secret is only shown in full when you first create the webhook. After that, only the last 4 characters are visible. If you lose it, delete the webhook and create a new one.
</Warning>

***

## Viewing your webhooks

The webhooks list shows each endpoint's status, subscribed events, and error rate at a glance.

<Frame caption="Webhook list showing status, events, and error rate">
  <img src="https://mintcdn.com/onejam/ySwBQh4Wxzua98C6/images/webhooks/webhook-list.png?fit=max&auto=format&n=ySwBQh4Wxzua98C6&q=85&s=3d3b02249a5b69a343139b2614876b9f" alt="Webhook list view" width="2874" height="1624" data-path="images/webhooks/webhook-list.png" />
</Frame>

| Field                    | Description                                               |
| ------------------------ | --------------------------------------------------------- |
| **Status**               | `ACTIVE` or `DISABLED`                                    |
| **Events**               | Which event types the webhook is subscribed to            |
| **Error rate**           | Percentage of failed deliveries over the last 7 days      |
| **Consecutive failures** | Current streak of failed deliveries (auto-disables at 10) |

***

## Editing a webhook

Click on any webhook to update its URL, name, description, or event subscriptions.

<Frame caption="Edit webhook settings and event subscriptions">
  <img src="https://mintcdn.com/onejam/ySwBQh4Wxzua98C6/images/webhooks/edit-webhook.png?fit=max&auto=format&n=ySwBQh4Wxzua98C6&q=85&s=9330610df2938b483625eacc83aec326" alt="Edit webhook form" width="2864" height="1958" data-path="images/webhooks/edit-webhook.png" />
</Frame>

<Info>
  When updating events, the entire subscription list is replaced. Make sure all the events you want are selected.
</Info>

***

## Enabling and disabling

Toggle a webhook's status directly from the webhook detail page:

* **Enable** — Reactivates the webhook and resets the failure counter to 0
* **Disable** — Pauses all deliveries until re-enabled

<Tip>
  Use disable instead of delete if you want to temporarily pause deliveries. You can re-enable at any time without losing your configuration or delivery history.
</Tip>

***

## Deleting a webhook

Click **Delete** to remove a webhook. Any pending deliveries in the queue will be skipped.

<Warning>
  Deletion cannot be undone. If you might need the webhook again, disable it instead.
</Warning>

***

## Sending a test event

Before going live, verify your endpoint by sending a test delivery.

<Steps>
  <Step title="Open the webhook">
    Go to **Settings > Webhooks** and click on the webhook you want to test.
  </Step>

  <Step title="Send a test">
    Choose an event type and click **Send Test Event**.
  </Step>

  <Step title="Check the result">
    The test delivery appears in the delivery log with a **Test** badge. Confirm your server received and processed it.
  </Step>
</Steps>

<Frame caption="Send a test event to verify your endpoint">
  <img src="https://mintcdn.com/onejam/ySwBQh4Wxzua98C6/images/webhooks/send-test.png?fit=max&auto=format&n=ySwBQh4Wxzua98C6&q=85&s=0ab5e975b692a91b0a9c6539d3cecd47" alt="Send test event dialog" width="2866" height="2196" data-path="images/webhooks/send-test.png" />
</Frame>

Test deliveries:

* Have `is_test: true` in the payload
* Are marked with a **Test** badge in the delivery history
* Work even when the webhook is **disabled**
* Use sample payloads with zeroed UUIDs (`00000000-0000-0000-0000-000000000000`)

***

## Webhook statuses

| Status     | Description                                                                      |
| ---------- | -------------------------------------------------------------------------------- |
| `ACTIVE`   | Receiving deliveries normally                                                    |
| `DISABLED` | Paused — either manually disabled or auto-disabled after 10 consecutive failures |

<Info>
  When a webhook reaches 10 consecutive failures, DeepSmith automatically disables it to protect your endpoint. Re-enable it from the platform after fixing the underlying issue.
</Info>