> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CloudPDF

> CloudPDF provides APIs for creating, uploading, managing, and securely sharing PDF documents and webhooks.

![CloudPDF logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/cloud_pdf.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=feb0cc91c2399c478df2e57598123421)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `CLOUD_PDF`
* **Version:** 00000000\_00

## Tools

> [accordion] Create Webhook
>
> **Slug:** `CLOUD_PDF_CREATE_WEBHOOK`
>
> Create a CloudPDF webhook subscription for selected document, collection, tracker, lead, or file-processing events.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public HTTPS callback URL that will receive CloudPDF events.
>
> **name** `string` *required*
>
> Short label identifying the webhook subscription.
>
> **events** `array`
>
> Event slugs to subscribe to; an empty list creates a subscription with no events.
>
> **secret** `string`
>
> Optional secret CloudPDF appends to callback requests as a query parameter.
>
> **headers** `object`
>
> Additional headers CloudPDF should send to the callback.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Document
>
> **Slug:** `CLOUD_PDF_DELETE_DOCUMENT`
>
> Permanently delete one known CloudPDF document by UUID. This destructive operation is irreversible, and CloudPDF provides no recovery endpoint.
>
> #### Input Parameters
>
> **document\_id** `string` *required*
>
> UUID of the CloudPDF document to permanently delete. This operation cannot be undone, and CloudPDF cannot restore the document.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `CLOUD_PDF_DELETE_WEBHOOK`
>
> Delete one CloudPDF webhook subscription by its decimal ID.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> Decimal webhook ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `CLOUD_PDF_GET_ACCOUNT`
>
> Return the connected CloudPDF organization's plan, allowances, and current upload, view, and storage usage.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Document
>
> **Slug:** `CLOUD_PDF_GET_DOCUMENT`
>
> Retrieve one CloudPDF document by ID, including metadata, default permissions, and current file processing status.
>
> #### Input Parameters
>
> **document\_id** `string` *required*
>
> CloudPDF document UUID obtained when the document was created; documents cannot be listed through the API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Document File
>
> **Slug:** `CLOUD_PDF_GET_DOCUMENT_FILE`
>
> Retrieve one known CloudPDF file version and its processing status. This returns file metadata, not the PDF bytes.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> UUID of the file version to inspect.
>
> **document\_id** `string` *required*
>
> UUID of the parent CloudPDF document.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook
>
> **Slug:** `CLOUD_PDF_GET_WEBHOOK`
>
> Retrieve one CloudPDF webhook subscription by its ID.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> Decimal webhook ID returned by create or list, such as 23.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `CLOUD_PDF_LIST_WEBHOOKS`
>
> Return all webhook subscriptions configured for the connected CloudPDF organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Document
>
> **Slug:** `CLOUD_PDF_UPDATE_DOCUMENT`
>
> Update selected metadata or default-permission fields on a known CloudPDF document without requiring unchanged values to be resent.
>
> #### Input Parameters
>
> **name** `string`
>
> New document name; keep the current name when omitted.
>
> **tags** `array`
>
> Complete replacement tag list; omission keeps current tags and an empty list removes all tags.
>
> **parent\_id** `string`
>
> New parent folder ID; omission keeps the current parent.
>
> **description** `string`
>
> New document description; omission keeps the current value. Mutually exclusive with clear\_description.
>
> **document\_id** `string` *required*
>
> UUID of the document to update; documents cannot be listed through the API.
>
> **clear\_description** `boolean`
>
> Set true to remove the current document description. Mutually exclusive with description.
>
> **default\_permissions** `object`
>
> Permission fields to merge into current defaults.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `CLOUD_PDF_UPDATE_WEBHOOK`
>
> Update selected fields of a CloudPDF webhook subscription without requiring unchanged values to be resent.
>
> #### Input Parameters
>
> **url** `string`
>
> New public HTTPS callback URL; omission keeps the current value.
>
> **name** `string`
>
> New webhook label; omission keeps the current value.
>
> **events** `array`
>
> Complete replacement event-slug list; omission keeps current events and an empty list removes all events.
>
> **secret** `string`
>
> New callback query-string secret; omission keeps the current value.
>
> **headers** `object`
>
> Complete replacement callback-header map; omission keeps current headers and an empty object removes all headers.
>
> **webhook\_id** `string` *required*
>
> Decimal webhook ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
