Sign up for free
View as Markdown

Update Webhook

PATCH/v2/webhooks/{id}

Changes the URL, events, description or status (active / paused). Re-activating a disabled webhook resets its failure counters; one whose creator or API key is gone answers 409 creator_removed. The URL and events can be changed only by the member or API key that created the webhook (403 creator_mismatch otherwise). Free: no credits.

Path parameters

  • idstringrequired

    The webhook id (24 hex characters).

Body parameters

  • urlstringoptionalmax length: 2048

    A new https URL on a public host. Only the creating member or API key may change it.

  • eventsenum[]optional

    Replaces the event types (1-10, no repeats). Only the creating member or API key may change them.

    Allowed values: person.saved person.email_found company.saved

  • descriptionstringoptionalmax length: 200

    A note for people reading the webhook list; null clears it.

  • statusenumoptional

    Pause or resume deliveries. Re-activating a disabled webhook resets its failure counters.

    Allowed values: active paused

  • api_versionenumoptional

    The payload version of the events (2026-10); defaults to the current one.

    Allowed values: 2026-10

Responses

  • 200 The webhook after the change.
  • 400 Malformed id or invalid body (VALIDATION_ERROR): invalid_format (the URL), value_not_allowed, out_of_range (1-10 events, or re-activating past 25 active webhooks), wrong_type, unknown_field.
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 403 Only the member or API key that created the webhook may change its URL or events (FORBIDDEN, payload.code: creator_mismatch).
  • 404 No such webhook in this workspace (NOT_FOUND).
  • 409 The member or API key that created this webhook is gone, so it cannot be re-activated; create a new one (CONFLICT, payload.code: creator_removed).
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.