PDFMonkey
API actions for the PDFMonkey integration.
PDFMonkey
Generate and manage documents using PDFMonkey templates.
Create document
Generate a PDF from one of your PDFMonkey templates, filled in with the data you provide.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | The ID of the PDFMonkey template to turn into a PDF. You can copy it from the template's page in PDFMonkey. |
payload | object | Yes | The fields and values that fill in the template's placeholders, for example the customer name or order total. |
metadata | object | No | Optional extra details to store with the document. Use "_filename" to set the name of the generated PDF file. |
Response
{
"document_id": "mock_value",
"document_status": "mock_value",
"status": "mock_value"
}Delete document
Permanently delete a generated document from PDFMonkey.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | Yes | The ID of the PDFMonkey document to delete. |
Response
{
"deleted": true,
"document_id": "mock_value",
"status": "mock_value"
}Get document status
Check whether a PDFMonkey document has finished generating and get its download link.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | Yes | The ID of the PDFMonkey document to check. |
Response
{
"document_id": "mock_value",
"document_status": "mock_value",
"download_url": "mock_value",
"failure_reason": "mock_value",
"filename": "mock_value",
"status": "mock_value"
}