# Update a webhook

Updates a webhook's properties. Supports partial updates - only provided fields will be updated.

### Path Parameters

- id - The webhook ID (24-character ObjectId)

### Request Body

All fields are optional. Only provided fields will be updated.

| Field | Type | Description |
|-------|------|-------------|
| name | string | Human-readable name (max 100 chars) |
| url | string | Webhook endpoint URL (must be HTTPS) |
| description | string/null | Description (null to clear) |
| topics | string[] | Event topics to subscribe to |
| status | string | "active" to reactivate, "paused" to pause delivery |
| requestConfig | object | Request configuration |
| requestConfig.headers | object | Custom headers to send (max 10) |

### Pausing and Reactivating Webhooks

You can pause a webhook to temporarily stop receiving events:

json
{
  "status": "paused"
}


Webhooks may also be automatically paused or suspended due to delivery failures. To reactivate:

json
{
  "status": "active"
}


Reactivating a webhook resets the health metrics and allows it to receive events again.

### Example: Update Topics

json
{
  "topics": ["post.created", "post.updated", "post.deleted"]
}


### Example: Update Request Config

json
{
  "requestConfig": {
    "headers": {
      "X-Custom-Header": "new-value"
    }
  }
}


### Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Endpoint: PATCH /v2/webhooks/{id}
Version: 2026-01-01.nova
Security: bearerAuth

## Header parameters:

  - `Featurebase-Version` (string)
    API version for this request. Defaults to your organization's configured API version if not specified.
    Example: "2026-01-01.nova"

## Path parameters:

  - `id` (string, required)
    Webhook unique identifier
    Example: "507f1f77bcf86cd799439011"

## Request fields (application/json):

  - `name` (string)
    Human-readable name for the webhook
    Example: "Production Webhook"

  - `url` (string)
    Webhook endpoint URL (must be HTTPS)
    Example: "https://example.com/webhooks"

  - `description` (string,null)
    Optional description of the webhook purpose (null to clear)
    Example: "Handles all production events"

  - `topics` (array)
    Array of event topics to subscribe to
    Enum: "post.created", "post.updated", "post.deleted", "post.voted", "changelog.published", "comment.created", "comment.updated", "comment.deleted"

  - `status` (string)
    Set to "active" to reactivate or "paused" to pause webhook delivery
    Enum: "active", "paused"

  - `requestConfig` (object)
    Request configuration for webhook delivery

  - `requestConfig.headers` (object)
    Custom headers to send with webhook requests (max 10)
    Example: {"X-Custom-Header":"value"}

## Response 200 fields (application/json):

  - `object` (string, required)
    Object type identifier
    Enum: "webhook"

  - `id` (string, required)
    Unique identifier
    Example: "507f1f77bcf86cd799439011"

  - `name` (string, required)
    Human-readable webhook name
    Example: "Production Webhook"

  - `url` (string, required)
    Webhook endpoint URL
    Example: "https://example.com/webhooks"

  - `secret` (string, required)
    Webhook signing secret for verifying payloads
    Example: "whsec_abc123def456ghi789"

  - `description` (string,null, required)
    Optional description of the webhook purpose
    Example: "Handles all production events"

  - `topics` (array, required)
    Array of event topics the webhook subscribes to
    Enum: "post.created", "post.updated", "post.deleted", "post.voted", "changelog.published", "comment.created", "comment.updated", "comment.deleted"

  - `status` (string, required)
    Current status of the webhook
    Enum: "active", "paused", "suspended"

  - `requestConfig` (object, required)

  - `requestConfig.timeoutMs` (integer, required)
    Request timeout in milliseconds (1000-30000)
    Example: 5000

  - `requestConfig.headers` (object)
    Custom headers to send with webhook requests
    Example: {"X-Custom-Header":"value"}

  - `lastStatus` (object,null, required)
    Last delivery attempt status

  - `lastStatus.code` (integer, required)
    HTTP status code from last delivery attempt
    Example: 200

  - `lastStatus.message` (string, required)
    Status message from last delivery attempt
    Example: "Success"

  - `lastStatus.timestamp` (string, required)
    ISO timestamp of last status update
    Example: "2025-01-15T10:30:00.000Z"

  - `health` (object, required)

  - `health.lastResponseTime` (number, required)
    Last response time in milliseconds
    Example: 150

  - `health.avgResponseTime` (number, required)
    Average response time in milliseconds
    Example: 200

  - `health.lastSuccessAt` (string,null, required)
    ISO timestamp of last successful delivery
    Example: "2025-01-15T10:30:00.000Z"

  - `health.errorsSinceLastSuccess` (integer, required)
    Number of errors since last successful delivery

  - `health.consecutiveFailures` (integer, required)
    Number of consecutive delivery failures

  - `version` (string, required)
    API version for webhook payloads
    Example: "1.0"

  - `createdAt` (string, required)
    ISO timestamp when the webhook was created
    Example: "2025-01-15T10:30:00.000Z"

  - `updatedAt` (string, required)
    ISO timestamp when the webhook was last updated
    Example: "2025-01-15T10:30:00.000Z"

## Response 400 fields (application/json):

  - `error` (object, required)

  - `error.type` (string, required)
    The type of error returned
    Enum: "invalid_request_error"

  - `error.code` (string, required)
    Machine-readable error code
    Enum: "invalid_parameter"

  - `error.message` (string, required)
    Human-readable error message
    Example: "An error occurred"

  - `error.param` (string)
    The parameter that caused the error (if applicable)
    Example: "id"

  - `error.status` (number, required)
    HTTP status code
    Enum: 400

## Response 404 fields (application/json):

  - `error` (object, required)

  - `error.type` (string, required)
    The type of error returned
    Enum: "invalid_request_error"

  - `error.code` (string, required)
    Machine-readable error code
    Enum: "webhook_not_found"

  - `error.message` (string, required)
    Human-readable error message
    Example: "An error occurred"

  - `error.param` (string)
    The parameter that caused the error (if applicable)
    Example: "id"

  - `error.status` (number, required)
    HTTP status code
    Enum: 404