Overview
This node integrates with the PDFMonkey API to manage PDF documents. It supports generating new PDFs from templates, retrieving document details and status, downloading generated PDF or image files, and deleting existing PDF documents.
Common scenarios include:
- Automating PDF report generation based on dynamic data.
- Retrieving the status of a PDF generation job.
- Downloading completed PDF documents for further processing or storage.
- Cleaning up by deleting obsolete or unwanted PDF documents.
For example, you can use this node to generate an invoice PDF from a template using customer data, wait for the PDF to be ready, then download it automatically. Alternatively, you can delete a document once it is no longer needed.
Properties
| Name | Meaning |
|---|---|
| Document ID | The ID of the generated document to get details, download, or delete. |
(Note: For the "Delete Document" operation, only the "Document ID" property is relevant.)
Output
The node outputs JSON data containing information about the requested operation:
- For Delete Document, the output JSON includes:
success: Boolean indicating if deletion was successful.message: Confirmation message.documentId: The ID of the deleted document.
No binary data is output for the delete operation.
Dependencies
- Requires an API key credential for authenticating with the PDFMonkey API.
- Makes HTTP requests to the PDFMonkey API endpoints.
- Uses n8n helper methods for HTTP requests and logging.
Troubleshooting
- Failed to delete document: This error occurs if the document ID is invalid or the API request fails. Ensure the document ID exists and the API key has proper permissions.
- API connection issues: Verify that the API key credential is correctly configured and active.
- Document not found: If the document ID does not exist, the API will return an error; double-check the ID value.