Skip to main content
CloudPDF logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: CLOUD_PDF
  • Version: 00000000_00

Tools

Slug: CLOUD_PDF_CREATE_WEBHOOKCreate a CloudPDF webhook subscription for selected document, collection, tracker, lead, or file-processing events.

Input Parameters

string
required
Public HTTPS callback URL that will receive CloudPDF events.
string
required
Short label identifying the webhook subscription.
array
Event slugs to subscribe to; an empty list creates a subscription with no events.
string
Optional secret CloudPDF appends to callback requests as a query parameter.
object
Additional headers CloudPDF should send to the callback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_DELETE_DOCUMENTPermanently delete one known CloudPDF document by UUID. This destructive operation is irreversible, and CloudPDF provides no recovery endpoint.

Input Parameters

string
required
UUID of the CloudPDF document to permanently delete. This operation cannot be undone, and CloudPDF cannot restore the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_DELETE_WEBHOOKDelete one CloudPDF webhook subscription by its decimal ID.

Input Parameters

string
required
Decimal webhook ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_GET_ACCOUNTReturn the connected CloudPDF organization’s plan, allowances, and current upload, view, and storage usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_GET_DOCUMENTRetrieve one CloudPDF document by ID, including metadata, default permissions, and current file processing status.

Input Parameters

string
required
CloudPDF document UUID obtained when the document was created; documents cannot be listed through the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_GET_DOCUMENT_FILERetrieve one known CloudPDF file version and its processing status. This returns file metadata, not the PDF bytes.

Input Parameters

string
required
UUID of the file version to inspect.
string
required
UUID of the parent CloudPDF document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_GET_WEBHOOKRetrieve one CloudPDF webhook subscription by its ID.

Input Parameters

string
required
Decimal webhook ID returned by create or list, such as 23.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_LIST_WEBHOOKSReturn all webhook subscriptions configured for the connected CloudPDF organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_UPDATE_DOCUMENTUpdate selected metadata or default-permission fields on a known CloudPDF document without requiring unchanged values to be resent.

Input Parameters

string
New document name; keep the current name when omitted.
array
Complete replacement tag list; omission keeps current tags and an empty list removes all tags.
string
New parent folder ID; omission keeps the current parent.
string
New document description; omission keeps the current value. Mutually exclusive with clear_description.
string
required
UUID of the document to update; documents cannot be listed through the API.
boolean
Set true to remove the current document description. Mutually exclusive with description.
object
Permission fields to merge into current defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUD_PDF_UPDATE_WEBHOOKUpdate selected fields of a CloudPDF webhook subscription without requiring unchanged values to be resent.

Input Parameters

string
New public HTTPS callback URL; omission keeps the current value.
string
New webhook label; omission keeps the current value.
array
Complete replacement event-slug list; omission keeps current events and an empty list removes all events.
string
New callback query-string secret; omission keeps the current value.
object
Complete replacement callback-header map; omission keeps current headers and an empty object removes all headers.
string
required
Decimal webhook ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not