Webhook endpoints

Update a webhook endpoint

Change the URL, events or description; enabled: true re-enables an endpoint we disabled after repeated failures, enabled: false pauses it.

patch/v1/webhook-endpoints/{id}/

Request

  • Base URL: https://api.pdfbetter.com
  • URL: https://api.pdfbetter.com/v1/webhook-endpoints/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

urlstring
descriptionstring nullable
enabledboolean

true re-enables an endpoint that was disabled after repeated failures

Response

Update a webhook endpoint

object'webhook_endpoint' required
idstring required
urlstring required
descriptionstring nullable required
status'enabled' | 'disabled' required
disabledReasonstring nullable required
failingSincestring nullable required

ISO 8601 timestamp (UTC)

createdAtstring required

ISO 8601 timestamp (UTC)

updatedAtstring required

ISO 8601 timestamp (UTC)

secretstring

Signing secret — returned only when the endpoint is created or its secret rotated

Changes

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