PDFMonkey

pdfmonkey

PDFMonkey is a service that automates the generation of PDF documents from templates, allowing users to create professional PDFs programmatically.

Documents Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (19)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create DocumentPDFMONKEY_CREATE_DOCUMENTAcción

Tool to create a Document. Use when you need to instantiate a PDF from a template; set status='pending' to queue immediate generation. Ensure valid `document_template_id` is provided.

Parámetros de entrada

documentobjectObligatorio
Document creation parameters wrapper.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Document SyncPDFMONKEY_CREATE_DOCUMENT_SYNCAcción

Tool to create a document and wait for generation to finish. Use when immediate PDF is needed.

Parámetros de entrada

documentobjectObligatorio
Container for document attributes

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TemplatePDFMONKEY_CREATE_TEMPLATEAcción

Tool to create a new Document Template. Use when you need to define a template with custom content, styles, and settings before generating PDF documents.

Parámetros de entrada

idstringObligatorio
UUID of the document template
ttlintegerenum
Auto-deletion TTL in seconds; allowed values: 300,1200,3600,86400,604800,2592000,31536000,0. If too high, highest allowed is used
30012003600864006048002592000315360000
bodystring
Published body (HTML + Liquid) used to generate documents
app_idstring
Workspace (application) UUID. If omitted, server default workspace may be used if supported.
settingsobject
Document printing settings for PDF generation or preview.
body_draftstring
Draft body (HTML + Liquid) used to preview changes
identifierstringObligatorio
Human name of the document template
scss_stylestring
Published (S)CSS used to generate documents
sample_datastring
Sample data used only to allow reverting changes
edition_modestringenum
Edition mode; defaults to 'code' if unset
codevisual
pdf_engine_idstring
PDF engine ID used to generate documents
settings_draftobject
Document printing settings for PDF generation or preview.
scss_style_draftstring
Draft (S)CSS used to preview changes
sample_data_draftstring
Draft sample data used for preview/testing
pdf_engine_draft_idstringObligatorio
PDF engine ID used to preview changes/test new engine

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DocumentPDFMONKEY_DELETE_DOCUMENTAcción

Tool to delete a Document by its ID. Use when you need to permanently remove a document after confirming its ID. Returns 204 No Content on success.

Parámetros de entrada

idstringObligatorio
UUID of the document to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete PDFMonkey Document TemplatePDFMONKEY_DELETE_TEMPLATEAcción

Tool to delete a document template by ID. Use when you need to remove obsolete templates after validation.

Parámetros de entrada

idstringObligatorio
The ID of the document template to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download Document FilePDFMONKEY_DOWNLOAD_DOCUMENT_FILEAcción

Tool to download a generated PDF file via a presigned URL. Use after obtaining a valid download_url from the Document details endpoint. The URL expires after 1 hour; fetch a new URL upon expiry (403 Forbidden).

Parámetros de entrada

download_urlstringObligatorio
Time-limited presigned URL returned by the Documents API. Valid for 1 hour; if expired, retrieve a new URL via the Document details endpoint.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current UserPDFMONKEY_GET_CURRENT_USERAcción

Tool to retrieve details about the currently authenticated user. Use when you need account info (quota, plan, email, locale) after authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DocumentPDFMONKEY_GET_DOCUMENTAcción

Tool to fetch a Document by its ID. Use when you need the full document record including payload, meta, logs, and download URL.

Parámetros de entrada

idstringObligatorio
UUID of the document to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DocumentCardPDFMONKEY_GET_DOCUMENT_CARDAcción

Tool to fetch a DocumentCard by ID. Use when you have a DocumentCard ID and need its download URLs, status, and metadata. Use after generating or updating a DocumentCard.

Parámetros de entrada

idstringObligatorio
UUID of the DocumentCard to fetch

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Template by IDPDFMONKEY_GET_TEMPLATEAcción

Tool to fetch a Document Template by ID. Use when you need the template's content, styles, settings, and preview URL.

Parámetros de entrada

idstringObligatorio
UUID of the document template to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DocumentCardsPDFMONKEY_LIST_DOCUMENT_CARDSAcción

Tool to list DocumentCards. Use when you need to retrieve multiple DocumentCards with optional pagination and filtering by template, status, workspace, or update time.

Parámetros de entrada

q[status]stringenum
Filter by document status
successfailuredraft
page[number]integer
Page number to return (default 1)
q[workspace_id]string
Filter by workspace UUID
q[updated_since]integer
Return documents updated after given Unix timestamp
q[document_template_id]string[]
Filter by one or more document template UUIDs

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List PDF EnginesPDFMONKEY_LIST_PDF_ENGINESAcción

Tool to list available PDF engines with deprecation metadata. Use when you need to choose a rendering engine before generating PDFs.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Template CardsPDFMONKEY_LIST_TEMPLATESAcción

Tool to list template cards for a workspace. Use when you need to retrieve templates with optional folder filters, pagination, and sorting.

Parámetros de entrada

pageinteger
Page number to return (1-indexed)
sortstringenum
Attribute by which to sort results
identifiercreated_atupdated_at
q[folders]string
Comma-separated folder IDs to filter templates; use 'none' to list only those in the root folder
q[workspaceId]stringObligatorio
The workspace ID to list templates from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WorkspacesPDFMONKEY_LIST_WORKSPACESAcción

Tool to list workspaces (applications). Use when you need all available workspaces for the authenticated user after login.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preview DocumentPDFMONKEY_PREVIEW_DOCUMENTAcción

Tool to open a document preview via a PDF.js viewer. Use when you need to embed the PDF preview in an iframe after obtaining the document ID.

Parámetros de entrada

idstringObligatorio
UUID of the document to retrieve preview for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preview TemplatePDFMONKEY_PREVIEW_TEMPLATEAcción

Tool to preview a template draft as a real PDF via the preview_url. Use after obtaining a template's preview_url.

Parámetros de entrada

preview_urlstringObligatorio
Preview URL for draft template fetched from the Template object's `preview_url` attribute. Use this full URL to retrieve the PDF preview.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DocumentPDFMONKEY_UPDATE_DOCUMENTAcción

Tool to update a Document’s payload, meta, or status. Use when you need to modify a document properties or regenerate it.

Parámetros de entrada

idstringObligatorio
UUID of the document to update
documentobjectObligatorio
Document update parameters wrapper.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Document TemplatePDFMONKEY_UPDATE_TEMPLATEAcción

Tool to update a document template’s properties. Use when you need to modify an existing template’s content, styles, settings, engine, folder, or TTL.

Parámetros de entrada

idstringObligatorio
UUID of the document template to update
ttlinteger
Auto-deletion TTL for generated documents (seconds), e.g., 300, 1200, 3600, etc.
bodystring
Published HTML+Liquid body used to generate documents
app_idstringObligatorio
Workspace ID
settingsobject
Printing settings for published template
body_draftstring
Draft HTML+Liquid body used for preview
identifierstringObligatorio
Human-readable name of the template
scss_stylestring
Published (S)CSS used to generate documents
preview_urlstring
Draft preview URL (can be embedded)
sample_datastring
Sample data for reverting changes
edition_modestringObligatorioenum
codevisual
pdf_engine_idstring
PDF engine UUID used to generate documents
settings_draftobject
Printing settings for draft preview
scss_style_draftstring
Draft (S)CSS used for preview
sample_data_draftstring
Draft sample data for preview
template_folder_idstring
Template folder UUID or null
pdf_engine_draft_idstring
PDF engine UUID used to preview changes

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View Public Share LinkPDFMONKEY_VIEW_PUBLIC_SHARE_LINKAcción

Tool to download a publicly shared PDF via its permanent share link. Use when the document's public_share_link is enabled to fetch the PDF file directly.

Parámetros de entrada

tokenstringObligatorio
Public share token from the document's public_share_link property.
filenamestringObligatorio
Filename of the PDF to retrieve, including .pdf extension.
public_share_urlstring
Optional full URL to download the PDF (e.g., a time-limited download_url from a DocumentCard). When provided, this URL is used directly instead of constructing the /share/:token/:filename path.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not