Get Document from PDF4me
PDF4me → Get Document from PDF4me
The Get Document from PDF4me API creates a webhook subscription so PDF4me can send documents to your callback URL. You send FileName (document filename in PDF4me storage), CallBackUrl (URL that receives webhook notifications), and optionally async. The API sets up the subscription; when the document is ready, PDF4me notifies your URL (e.g. for Power Automate). Use the tester below to try it; more details are in the sections that follow.
Try the Get Document from PDF4me API
Endpoint: POST /api/v2/WebhookSubscribe · Required: api-key, FileName, CallBackUrl
Use the form below to send your API key, document filename (in PDF4me storage), and callback URL. The API creates a webhook subscription; your URL receives notifications when the document is ready. No code required—fill the fields and click Send request.
Overview, parameters, and use cases
- Overview
- Parameters
- Use cases
What is Get Document from PDF4me?
This endpoint creates a webhook subscription so PDF4me can send document notifications to your callback URL. You provide FileName (a document filename that exists in PDF4me storage) and CallBackUrl (a valid, accessible URL). When the document is ready or processed, PDF4me sends a notification to your URL. Use it with Power Automate or other workflows that need to be triggered when a document is available.
Webhook subscription
This endpoint creates a webhook subscription that:
- Monitors for documents with the specified filename in PDF4me storage
- Sends document processing notifications to the callback URL
- Triggers Power Automate flows or other automated workflows when documents are processed
- Enables integration with external systems (e.g. Power Automate, Zapier)
Use when you need to receive documents from PDF4me storage via webhook (e.g. Power Automate, custom backends). For updating links in a PDF use Update Hyperlinks Annotation.
API parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api-key | string | Yes | Your PDF4me API key, Base64 encoded. Get it from the dashboard. |
| FileName | string | Yes | Source document filename with .pdf extension (must exist in PDF4me storage). |
| CallBackUrl | string | Yes | Callback URL that receives webhook notifications (must be valid and accessible). |
| async | boolean | No | Enable asynchronous processing. |
When to use Get Document from PDF4me
- Power Automate – Trigger flows when a document is ready in PDF4me storage.
- Webhook integration – Receive document notifications at your callback URL for custom backends.
- Automated workflows – Connect PDF4me processing to downstream systems (e.g. CRM, storage, email).
- Document retrieval – Get notified when a document is available so you can fetch or process it.
For request/response schemas and code samples, see Get Document from PDF4me in the PDF4me API docs.
Prerequisites
Before using this endpoint, make sure you have:
- A valid PDF4me API key (Get your API Key)
- A document filename that exists in PDF4me storage
- A valid callback URL endpoint that can receive webhook notifications
Response Format
The API returns a response indicating the webhook subscription status and configuration.