Webhook endpoints

Rotate the signing secret

Returns a new secret, effective immediately — deploy it to your receiver right away. The old secret stops verifying.

post/v1/webhook-endpoints/{id}/rotate-secret/

Request

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

Path parameters

idstring required

Response

Rotate the signing secret

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.