---
title: "Update a webhook configuration."
method: PATCH
path: "/api/v1/webhooks/{webhookConfigId}/"
tags: ["Webhook Configuration"]
---

# Update a webhook configuration.

`PATCH /api/v1/webhooks/{webhookConfigId}/`

## Request

- Base URL: `https://partnerapi-staging.depop.com`
- URL: `https://partnerapi-staging.depop.com/api/v1/webhooks/{webhookConfigId}/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/depop/apis/seller-api/docs/api/v1/webhooks/:webhookConfigId/patch.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you to partially update an existing webhook configuration.
At least one of `url`, `enabled` or `event_types` must be provided. Any field which is not provided keeps its current value. If `event_types` is provided it replaces the existing list entirely rather than being merged with it.

## Path parameters

- `webhookConfigId` string, uuid, required

## Request body

- WebhookUpdateRequest: A partial update to a webhook configuration. At least one of `url`, `enabled` or `event_types` must be provided. Any field which is not provided keeps its current value.
  - `url` string, url: The publicly accessible URL where you wish to receive incoming webhooks. This must be a valid HTTPS url.
  - `enabled` boolean: If this webhook configuration is enabled webhooks will be sent to the configured URL. If enabled is false no webhooks will be sent.
  - `event_types` string[]: The Depop event types you wish to receive webhooks for. Event types can either be the full name of an event, e.g. `v1:order.new`, or an event prefix with a wildcard. For example, if you wished to subscribe to all `v1` events you could supply the event type `v1:*`, or if you wished to subscribe to all order events `v1:order.*`. Supplying a wildcard will also automatically subscribe you to any new events created in future which match that scheme. Wildcards must specify an event version, and can optionally supply a resource, however this cannot be a partial resource. See below for some examples: Valid: - v1:* - v1:order.* - v1:product.* Invalid: - * - v1* - v1:ord* - v1:product.*like - v1:product.u*

## Response `200`

Webhook configuration was updated successfully.

- WebhookUpdateResponse
  - `webhook_id` string, uuid, required: The ID of the updated webhook configuration.
  - `url` string, url, required: The URL where incoming webhooks will be received.
  - `enabled` boolean, required: Whether this webhook configuration is enabled.
  - `event_types` string[], required: The Depop event types you wish to receive webhooks for. Event types can either be the full name of an event, e.g. `v1:order.new`, or an event prefix with a wildcard. For example, if you wished to subscribe to all `v1` events you could supply the event type `v1:*`, or if you wished to subscribe to all order events `v1:order.*`. Supplying a wildcard will also automatically subscribe you to any new events created in future which match that scheme. Wildcards must specify an event version, and can optionally supply a resource, however this cannot be a partial resource. See below for some examples: Valid: - v1:* - v1:order.* - v1:product.* Invalid: - * - v1* - v1:ord* - v1:product.*like - v1:product.u*

## Other responses

- `400`: Webhook update request was invalid.
- `401`: Unauthorized
- `403`: Forbidden - Insufficient scope
- `404`: Webhook configuration was not found.
- `409`: A webhook configuration with the given URL already exists.
- `429`: Too Many Requests - the rate limit for a shop or seller, or the overall limit for your integration, has been exceeded.
- `502`: Bad Gateway - an upstream service required to build the insights response failed or returned an unexpected response.

---

[API](https://skmtc.dev/depop/apis/seller-api.md) - [All operations](https://skmtc.dev/depop/apis/seller-api/llms.txt) - [OpenAPI document](https://skmtc.dev/depop/apis/seller-api/revisions/56fef8e38e44?raw)