---
title: "Change a webhook"
method: PATCH
path: "/v1/webhooks/{id}"
tags: ["Webhooks"]
---

# Change a webhook

`PATCH /v1/webhooks/{id}`

## Request

- Base URL: `https://api.nvoke.run`
- URL: `https://api.nvoke.run/v1/webhooks/{id}`
- Auth: HTTP bearer

Change the URL, events or scope, or pause and resume it with `enabled`. `dropId: null` widens it to the whole scope again.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `url` string, uri: Where to POST events. HTTPS on a public address.
  - `events` string[]: The events to send.
  - `scope` 'all' | 'drops': `all`: every search. `drops`: only searches a drop made.
  - `dropId` string, uuid, nullable: Only searches this drop made. Implies scope `drops`.
  - `enabled` boolean

## Response `200`

OK

- object
  - `id` string, uuid, required
  - `url` string, required
  - `events` string[], required
  - `scope` 'all' | 'drops', required
  - `dropId` string, uuid, nullable, required
  - `enabled` boolean, required
  - `disabledReason` 'failing', nullable, required
  - `lastSuccessAt` string, date-time, nullable, required
  - `lastFailureAt` string, date-time, nullable, required
  - `lastError` string, nullable, required
  - `createdAt` string, date-time, required

## Other responses

- `4XX`: `unauthorized`: No valid token. Send `Authorization: Bearer <key>`. `not_found`: No such search, key or webhook on this account. `invalid_request`: The body or query failed validation. `details` lists the problems. `webhook_url_not_allowed`: Webhook URLs must be HTTPS on a public address that resolves.

---

[API](https://skmtc.dev/nvoke/apis/nvoke-api.md) · [All operations](https://skmtc.dev/nvoke/apis/nvoke-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nvoke/apis/nvoke-api/revisions/6d78de7201f3?raw)