Skip to main content

API Keys

Use the API Keys section to create, copy, rename, and block API keys, and access the webhook signing secret for async callbacks.

API Keys page for managing, generating, and editing API keys securely

Key Features​

  • Manage Multiple Keys: Generate and manage up to 5 API keys.
  • Assign Descriptive Names: Name your API keys by purpose, such as staging or production.
  • Manage Key Status:
    • Active: Keys currently in use and functional. Newly generated keys are active by default.
    • Blocked: Keys that can no longer authorize API requests.
  • Rename Keys: Update key names when their purpose changes.

How to Use​

  1. Generate New Keys: Click New API Key to create a key if fewer than 5 keys exist, or use the key created automatically at registration.

  2. Copy Key: Click the Copy icon next to a key to copy it to your clipboard.

Details view of an API key, showing its name, status, copy and edit button

  1. Use the Key: Send the key in the API-KEY header when calling the PDFBolt API.

  2. Rename Existing Keys: Use Edit to change a key name. Names can be up to 50 characters.

  3. Block a Key: In the edit dialog, change the key status to Blocked only when you want the key to stop authorizing API requests.

Edit button to rename or block an API key

Modal window for editing an API key, including renaming or blocking options

Security Notes
  • Keep your API keys secure: Do not share them publicly or expose them in client-side code.
  • Blocked keys cannot be unblocked in the Dashboard: Once an API key is blocked, create a new key or contact support to restore access.

Webhook Signature​

Below the API keys table, the Webhook Signature section shows the secret PDFBolt uses to sign webhook requests for /v1/async conversions. Use it to verify that a webhook came from PDFBolt.

  • Click the eye icon to show or hide the secret.
  • Click the copy icon to copy it to your clipboard.

Webhook Signature section showing the secret key with show/hide and copy options

For details on how to verify webhook signatures in your code, see Webhook Signature Verification.