Skip to navigation
Paperwork APIWebhooks

Update a webhook endpoint

View as Markdown

Changes a saved endpoint in place, keeping its id.

  • url — re-point it somewhere else.
  • events — re-filter which types it receives.
  • disabled: true — pause deliveries without losing the endpoint.
{ "disabled": true }

Runs already in flight pick the change up immediately: they hold the whe_ reference, not a URL snapshot. Rotating an endpoint mid-run reroutes the rest of that run’s deliveries.

Learn more: Webhooks guide

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired>=1 character

Request

This endpoint expects an object.
urlstringOptionalformat: "uri"
eventslist of enumsOptional
disabledbooleanOptional

Response

The updated endpoint.
object"webhook_endpoint"
idstring
urlstring
disabledboolean
createdAtstring
eventslist of stringsOptional

Errors

404
Not Found Error
429
Too Many Requests Error