---
title: "Update a Webhook subscription"
method: PATCH
path: "/webhooks/{webhookId}"
tags: ["Webhook"]
---

# Update a Webhook subscription

`PATCH /webhooks/{webhookId}`

Updates a given Webhook subscription.
Any parameters not provided are left unchanged.

## Path parameters

- `webhookId` string, uuid, required — The unique identifier for a resource.

## Request body

- UpdateWebhookSubscription
  - `endpoint` string, uri — HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.
  - `description` string, safe-string, nullable — Short description of the webhook.\ This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
  - `sandbox` boolean
  - `subscribed_events` union — Select all the events to subscribe to.
    - string[] — List of specific webhook events to subscribe to.
    - string[] — Allows you to subscribe to all events currently existing.
  - `secret_key` string, nullable — Autogenerated 32 bytes key
  - `scopes` union — Choose between a wildcard symbol to select all scopes or specify a list of specific scopes.
    - string[] — One or multiple specific scopes to subscribe.
    - string[] — Wildcard scope to subscribe to all scopes.
  - `workspaces` union — Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs. The association of specific Workspaces with Webhook is temporarily restricted in the sandbox environment, only the value wildcard ("*") for Workspaces is allowed in this context.
    - UUID[] — List of Workspace UUIDs.
    - string[] — Allows you to select all Workspaces.
  - `auto_retry` boolean — If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min
  - `enabled` boolean — Choose whether the webhook is enabled or not.

## Response `200`

OK

- WebhookSubscription
  - `id` string, uuid, required
  - `endpoint` string, uri, required — HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.
  - `description` string, nullable, required — Short description of the webhook
  - `sandbox` boolean, required
  - `subscribed_events` union, required — Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs.
    - string[] — Allows you to subscribe to all events currently existing.
    - string[] — List of specific webhook events to subscribe to.
  - `secret_key` string, required — Autogenerated 32 bytes key
  - `scopes` union, required
    - string[] — Wildcard scope to subscribe to all scopes.
    - string[] — One or multiple specific scopes to subscribe.
  - `workspaces` union, required
    - string[] — Allows you to select all Workspaces.
    - UUID[] — List of Workspace UUIDs.
  - `auto_retry` boolean, required — If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min
  - `enabled` boolean, required — Is the webhook enabled?
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable, required

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `404` — Resource not found
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)