---
title: "Update webhook"
method: PATCH
path: "/webhooks/{webhookId}"
tags: ["Webhooks V2"]
---

# Update webhook

`PATCH /webhooks/{webhookId}`

## Request

- Base URL: `https://api.fireblocks.io/v1`
- URL: `https://api.fireblocks.io/v1/webhooks/{webhookId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/webhooks/:webhookId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update a webhook by its id

Endpoint Permission: Owner, Admin, Non-Signing Admin.

## Path parameters

- `webhookId` string, uuid, required

## Request body

- UpdateWebhookRequest
  - `url` string: The url of the webhook where notifications will be sent. URL must be valid, unique and https.
  - `description` string: description of the webhook of what it is used for.should not contain special characters.
  - `events` WebhookEvent[]: The events that the webhook will be subscribed to
  - `enabled` boolean: The status of the webhook
  - `webhookMtlsId` string, uuid, nullable: The id of the mTLS configuration this webhook presents when delivering, from `/v1/webhooks_settings/mtls`. Several webhooks may share one configuration, so replacing its certificate covers all of them at once. Send `null` to stop using mTLS for this webhook.
  - `webhookOauthId` string, uuid, nullable: The id of the OAuth credentials this webhook authenticates with, from `/v1/webhooks_settings/oauth`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. Send `null` to stop using OAuth for this webhook. Cannot be combined with an `authorization` custom header on the same webhook; a request that would leave both set is rejected.
  - `customHeaders` WebhookCustomHeadersUpdate, nullable: A delta applied to the delivery headers. A header with a value is added or replaced, a header with `null` is deleted, and one you leave out is untouched. A value replaces what is stored under that name rather than adding to it, so an array is the complete new set of lines for that header. Send `customHeaders: null` to clear every header in one call. That does not collide with a `null` value on a name: one names the header to delete, the other names the whole field. Names are case-insensitive, so a `null` under one casing deletes a header stored under another. Same rules as on create: string or non-empty array, `Cookie` and `Authorization` string-only, 10 headers and under 16 KB in the resulting set, the same reserved names, and values write-only. Entries set to `null` do not count towards the limit. `Authorization` cannot be combined with `webhookOauthId`, though one request may add it and detach the credentials together.

## Response `200`

Updated webhook object

- Webhook
  - `id` string, uuid, required: The id of the webhook
  - `url` string, required: The url of the webhook where notifications will be sent. Must be a valid URL and https.
  - `description` string: description of the webhook of what it is used for
  - `events` WebhookEvent[], required: The events that the webhook will be subscribed to
  - `status` 'DISABLED' | 'ENABLED' | 'SUSPENDED', required: The status of the webhook
  - `createdAt` integer, required: The date and time the webhook was created in milliseconds
  - `updatedAt` integer, required: The date and time the webhook was last updated in milliseconds
  - `webhookMtlsId` string, uuid: The id of the mTLS configuration this webhook presents when delivering, from `/v1/webhooks_settings/mtls`. Absent when the webhook does not use mTLS.
  - `webhookOauthId` string, uuid: The id of the OAuth credentials this webhook authenticates with. Absent when the webhook does not use OAuth. Read the credentials themselves from `/v1/webhooks_settings/oauth/{webhookOauthId}`.
  - `customHeaders` string[]: Names of the custom headers configured for this webhook. Header values are never returned.

## Other responses

- `default`: Error Response

---

[API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)