Webhooks

Update, pause or resume a webhook endpoint

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.

patch/webhooks/{id}

Request

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

Path parameters

idstring uuid required

Request body

pausedboolean

true pauses the endpoint; false resumes it and clears the paused reason.

pausedReasonstring nullable

Free-form note surfaced in the dashboard's paused-reason banner. Requires paused; ignored when paused: false.

urlstring uri

New delivery URL. Must be HTTPS and resolve to a public address (same check as create).

eventTypesstring[]

Replacement set of subscribed event types.

Response

Updated endpoint

idstring uuid required
urlstring uri required
descriptionstring nullable required
eventTypesstring[] required

Subscription filter. Empty array = subscribe to every event type the platform emits today and in the future.

pausedboolean required
pausedReasonstring nullable required
pausedAtstring date-time nullable required
consecutiveFailuresinteger required
lastSuccessAtstring date-time nullable required
lastFailureAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.