---
title: "Update, pause or resume a webhook endpoint"
method: PATCH
path: "/webhooks/{id}"
tags: ["Webhooks"]
---

# Update, pause or resume a webhook endpoint

`PATCH /webhooks/{id}`

## Request

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

Changes the endpoint's URL or subscribed events, and/or pauses it with an optional reason or resumes it (also resets the failure counter). Existing in-flight retries finish on their own schedule.

## Path parameters

- `id` string, uuid, required

## Request body

- PatchWebhookRequest
  - `paused` boolean: `true` pauses the endpoint; `false` resumes it and clears the paused reason.
  - `pausedReason` string, nullable: Free-form note surfaced in the dashboard's paused-reason banner. Requires `paused`; ignored when `paused: false`.
  - `url` string, uri: New delivery URL. Must be HTTPS and resolve to a public address (same check as create).
  - `eventTypes` string[]: Replacement set of subscribed event types.

## Response `200`

Updated endpoint

- WebhookEndpoint
  - `id` string, uuid, required
  - `url` string, uri, required
  - `description` string, nullable, required
  - `eventTypes` string[], required: Subscription filter. Empty array = subscribe to every event type the platform emits today and in the future.
  - `paused` boolean, required
  - `pausedReason` string, nullable, required
  - `pausedAt` string, date-time, nullable, required
  - `consecutiveFailures` integer, required
  - `lastSuccessAt` string, date-time, nullable, required
  - `lastFailureAt` string, date-time, nullable, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `400`: Bad request — body or path could not be parsed
- `401`: Unauthenticated — credentials missing, malformed, invalid, or revoked
- `404`: Not found
- `422`: Validation failed — request body / query / path is structurally wrong
- `429`: Rate limited or daily ceiling exceeded
- `500`: Internal server error

---

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