## Update a webhook

`client.webhooks.update(stringid, WebhookUpdateParamsparams, RequestOptionsoptions?): Webhook`

**patch** `/v2/webhooks/{id}`

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.

### Parameters

- `id: string`

  Webhook unique identifier

- `params: WebhookUpdateParams`

  - `description?: string | null`

    Body param: Optional description of the webhook purpose (null to clear)

  - `name?: string`

    Body param: Human-readable name for the webhook

  - `requestConfig?: WebhookRequestConfigInput`

    Body param: Request configuration for webhook delivery

    - `headers?: Record<string, string>`

      Custom headers to send with webhook requests (max 10)

  - `status?: "active" | "paused"`

    Body param: Set to "active" to reactivate or "paused" to pause webhook delivery

    - `"active"`

    - `"paused"`

  - `topics?: Array<"post.created" | "post.updated" | "post.deleted" | 24 more>`

    Body param: Array of event topics to subscribe to

    - `"post.created"`

    - `"post.updated"`

    - `"post.deleted"`

    - `"post.voted"`

    - `"ticket.created"`

    - `"ticket.updated"`

    - `"ticket.deleted"`

    - `"changelog.published"`

    - `"comment.created"`

    - `"comment.updated"`

    - `"comment.deleted"`

    - `"conversation.user.created"`

    - `"conversation.user.replied"`

    - `"conversation.admin.replied"`

    - `"conversation.admin.closed"`

    - `"conversation.handover_requested"`

    - `"conversation.admin.assigned"`

    - `"conversation.admin.noted"`

    - `"conversation.admin.snoozed"`

    - `"conversation.admin.unsnoozed"`

    - `"conversation.admin.opened"`

    - `"conversation.priority.updated"`

    - `"conversation.deleted"`

    - `"conversation.contact.attached"`

    - `"conversation.contact.detached"`

    - `"conversation.read"`

    - `"conversation_part.redacted"`

  - `url?: string`

    Body param: Webhook endpoint URL (must be HTTPS)

  - `featurebaseVersion?: "2026-01-01.nova" | "2025-12-12.clover"`

    Header param: API version for this request. Defaults to your organization's configured API version if not specified.

    - `"2026-01-01.nova"`

    - `"2025-12-12.clover"`

### Returns

- `Webhook`

  - `id: string`

    Unique identifier

  - `createdAt: string`

    ISO timestamp when the webhook was created

  - `description: string | null`

    Optional description of the webhook purpose

  - `health: Health`

    - `avgResponseTime: number`

      Average response time in milliseconds

    - `consecutiveFailures: number`

      Number of consecutive delivery failures

    - `errorsSinceLastSuccess: number`

      Number of errors since last successful delivery

    - `lastResponseTime: number`

      Last response time in milliseconds

    - `lastSuccessAt: string | null`

      ISO timestamp of last successful delivery

  - `lastStatus: LastStatus | null`

    Last delivery attempt status

    - `code: number`

      HTTP status code from last delivery attempt

    - `message: string`

      Status message from last delivery attempt

    - `timestamp: string`

      ISO timestamp of last status update

  - `name: string`

    Human-readable webhook name

  - `object: "webhook"`

    Object type identifier

    - `"webhook"`

  - `requestConfig: RequestConfig`

    - `timeoutMs: number`

      Request timeout in milliseconds (1000-30000)

    - `headers?: Record<string, string>`

      Custom headers to send with webhook requests

  - `secret: string`

    Webhook signing secret for verifying payloads

  - `status: "active" | "paused" | "suspended"`

    Current status of the webhook

    - `"active"`

    - `"paused"`

    - `"suspended"`

  - `topics: Array<"post.created" | "post.updated" | "post.deleted" | 24 more>`

    Array of event topics the webhook subscribes to

    - `"post.created"`

    - `"post.updated"`

    - `"post.deleted"`

    - `"post.voted"`

    - `"ticket.created"`

    - `"ticket.updated"`

    - `"ticket.deleted"`

    - `"changelog.published"`

    - `"comment.created"`

    - `"comment.updated"`

    - `"comment.deleted"`

    - `"conversation.user.created"`

    - `"conversation.user.replied"`

    - `"conversation.admin.replied"`

    - `"conversation.admin.closed"`

    - `"conversation.handover_requested"`

    - `"conversation.admin.assigned"`

    - `"conversation.admin.noted"`

    - `"conversation.admin.snoozed"`

    - `"conversation.admin.unsnoozed"`

    - `"conversation.admin.opened"`

    - `"conversation.priority.updated"`

    - `"conversation.deleted"`

    - `"conversation.contact.attached"`

    - `"conversation.contact.detached"`

    - `"conversation.read"`

    - `"conversation_part.redacted"`

  - `updatedAt: string`

    ISO timestamp when the webhook was last updated

  - `url: string`

    Webhook endpoint URL

  - `version: string`

    API version for webhook payloads

### Example

```typescript
import Featurebase from 'featurebase-node';

const client = new Featurebase({
  apiKey: process.env['FEATUREBASE_API_KEY'], // This is the default and can be omitted
});

const webhook = await client.webhooks.update('507f1f77bcf86cd799439011');

console.log(webhook.id);
```

#### Response

```json
{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "description": "Handles all production events",
  "health": {
    "avgResponseTime": 200,
    "consecutiveFailures": 0,
    "errorsSinceLastSuccess": 0,
    "lastResponseTime": 150,
    "lastSuccessAt": "2025-01-15T10:30:00.000Z"
  },
  "lastStatus": {
    "code": 200,
    "message": "Success",
    "timestamp": "2025-01-15T10:30:00.000Z"
  },
  "name": "Production Webhook",
  "object": "webhook",
  "requestConfig": {
    "timeoutMs": 5000,
    "headers": {
      "X-Custom-Header": "value"
    }
  },
  "secret": "whsec_abc123def456ghi789",
  "status": "active",
  "topics": [
    "post.created",
    "post.updated"
  ],
  "updatedAt": "2025-01-15T10:30:00.000Z",
  "url": "https://example.com/webhooks",
  "version": "1.0"
}
```