Webhook endpoints

Create a webhook endpoint

https only; the host must resolve to a public address. The signing secret is returned in this response only. Up to 10 endpoints.

Idempotency-Key is ignored here so the secret is never stored for replay.

post/v1/webhook-endpoints/

Request

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

Request body

urlstring required

https URL that accepts POSTs

descriptionstring

Response

Create 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.