Webhooks

Create webhook endpoint

Registers a public http(s) URL. Non-global destinations (loopback, private, link-local, CGNAT and other reserved ranges, IPv4 and IPv6) are rejected at registration and re-validated before every delivery. The signing secret (whsec_...) is returned exactly once. Requires a paid plan.

post/v2/organizations/{organizationId}/webhooks

Request

  • Base URL: https://api.pdfs.build
  • URL: https://api.pdfs.build/v2/organizations/{organizationId}/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Public http(s) destination.

descriptionstring
enabledboolean

Response

The endpoint and its secret.

secretstring required

Standard Webhooks signing secret (whsec_ + base64). Shown once; store it now.

Example response

{
  "endpoint": {
    "id": "whe_5xg6Kq0PSTeK1bXf3eDR3w",
    "createdAt": "2026-08-30T12:00:00.123456",
    "updatedAt": "2026-08-30T12:00:00.123456"
  },
  "secret": "whsec_MfKjnR7bCq4Xy1UvZ0aW3sTdE9gHpLqI5oN2kBjA8xY="
}

Changes

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