# Change a webhook

> Changes the address, the event types or the description, or pauses or resumes it.

`PATCH /v1/webhooks/{id}`

Changes the address, the event types or the description, or pauses or resumes it. Resuming sends what waited from the last 72 hours.

Needs a key with the `webhooks:manage` scope. [Keys and scopes](https://usebluebot.com/docs/concepts/api-keys)

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The webhook’s id. Starts with `wh_` |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | No | Up to 2,048 characters |
| `events` | array of any | No | Replaces its event types. `["*"]` for every type, including types BlueBot adds later; a list stops new types reaching it. |
| `description` | string or null | No | Up to 200 characters |
| `paused` | boolean | No | `true` pauses it; `false` resumes it and sends what waited from the last 72 hours. |

## Example

```bash
curl -X PATCH "https://usebluebot.com/api/v1/webhooks/wh_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paused": true
  }'
```

```ts
import BlueBot from '@usebluebot/sdk';

const client = new BlueBot({ apiKey: process.env.BLUEBOT_API_KEY });

const webhook = await client.webhooks.update('wh_1Hq2LxW9cVbN3mKpRtYs0a', {
  paused: true,
});
console.log(webhook);
```

```python
import os
from bluebot import BlueBot

client = BlueBot(api_key=os.environ["BLUEBOT_API_KEY"])

webhook = client.webhooks.update("wh_1Hq2LxW9cVbN3mKpRtYs0a", paused=True)
print(webhook)
```

## Response

`200`: The webhook after the change.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | A wh_ id. Starts with `wh_` |
| `object` | "webhook" | Yes |   |
| `url` | string | Yes |   |
| `description` | string or null | Yes |   |
| `events` | array of strings | Yes | The event types it receives. For a webhook made with `["*"]`, every type there is now. One of `message.queued`, `message.sent`, `message.delivered`, `message.read`, `message.failed`, `message.unconfirmed`, `message.expired`, `message.canceled`, `message.received`, `message.edited`, `message.unsent`, `reaction.added`, `reaction.removed`, `chat.created`, `contact.created`, `contact.stopped`, `contact.unstopped`, `sequence.completed`, `broadcast.completed`, `automation.matched`, `device.online`, `device.offline`, `device.check_failed` |
| `all_events` | boolean | Yes | True when it was made with `["*"]`: it also receives event types BlueBot adds later. |
| `api_version` | string | Yes | The payload version it was made with and keeps. |
| `status` | string | Yes | `active`; `failing` while deliveries fail (retried for about 3 days); `paused` by you, or after 72 hours with no successful answer. One of `active`, `failing`, `paused` |
| `paused_at` | timestamp or null | Yes | When it was paused. |
| `pause_reason` | string or null | Yes | Who paused it: `failing` (72 hours of failures), `customer` or `staff`. One of `failing`, `customer`, `staff` |
| `failing_since` | timestamp or null | Yes | The first failure since the last success. |
| `last_success_at` | timestamp or null | Yes | The last delivery answered with a 2xx. |
| `last_failure_at` | timestamp or null | Yes | The last delivery that failed. |
| `last_status` | integer or null | Yes | The HTTP status of the last answer. |
| `previous_secret_expires_at` | timestamp or null | Yes | After a rotation, when the old secret stops signing alongside the new one. |
| `created_at` | timestamp | Yes | When it was made. |

The answer, `200`:

```json
{
  "id": "wh_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "webhook",
  "url": "https://hooks.zapier.com/hooks/standard/1234567/abcdef/",
  "description": "New replies to my CRM",
  "events": [
    "message.received",
    "message.failed"
  ],
  "all_events": false,
  "api_version": "2026-11-13",
  "status": "paused",
  "paused_at": "2026-11-13T19:41:00.000Z",
  "pause_reason": "customer",
  "failing_since": null,
  "last_success_at": "2026-11-13T19:44:13.000Z",
  "last_failure_at": null,
  "last_status": 200,
  "previous_secret_expires_at": null,
  "created_at": "2026-11-01T15:10:00.000Z"
}
```

## Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

| Code                                                    | Status | What it means                                                                                                                                    |
| ------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`unauthorized`](https://usebluebot.com/docs/errors/unauthorized)             | 401    | The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.                                |
| [`insufficient_scope`](https://usebluebot.com/docs/errors/insufficient_scope) | 403    | The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.                                                   |
| [`rate_limited`](https://usebluebot.com/docs/errors/rate_limited)             | 429    | Too many requests. A key may make 120 requests a minute. The `RateLimit` header says how many are left, and `Retry-After` how long to wait.      |
| [`internal`](https://usebluebot.com/docs/errors/internal)                     | 500    | Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.                    |
| [`invalid_request`](https://usebluebot.com/docs/errors/invalid_request)       | 400    | Something in the request doesn’t fit: a missing or malformed field, a bad id, or a combination the endpoint refuses. `details` names each field. |
| [`not_found`](https://usebluebot.com/docs/errors/not_found)                   | 404    | There is no such thing on this account. Ids are prefixed by kind, so a message id starts with `msg_`.                                            |

## Try it