---
canonical_url: "https://docs.composio.dev/toolkits/cloud_pdf"
markdown_url: "https://docs.composio.dev/toolkits/cloud_pdf.md"
product: "platform"
version: null
last_updated: null
---

# CloudPDF

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

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

## Tools

### Create Webhook

**Slug:** `CLOUD_PDF_CREATE_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTPS callback URL that will receive CloudPDF events. |
| `name` | string | Yes | Short label identifying the webhook subscription. |
| `events` | array | No | Event slugs to subscribe to; an empty list creates a subscription with no events. |
| `secret` | string | No | Optional secret CloudPDF appends to callback requests as a query parameter. |
| `headers` | object | No | Additional headers CloudPDF should send to the callback. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | UUID of the CloudPDF document to permanently delete. This operation cannot be undone, and CloudPDF cannot restore the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `CLOUD_PDF_DELETE_WEBHOOK`

Delete one CloudPDF webhook subscription by its decimal ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Decimal webhook ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `CLOUD_PDF_GET_ACCOUNT`

Return the connected CloudPDF organization's plan, allowances, and current upload, view, and storage usage.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document

**Slug:** `CLOUD_PDF_GET_DOCUMENT`

Retrieve one CloudPDF document by ID, including metadata, default permissions, and current file processing status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | CloudPDF document UUID obtained when the document was created; documents cannot be listed through the API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | UUID of the file version to inspect. |
| `document_id` | string | Yes | UUID of the parent CloudPDF document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `CLOUD_PDF_GET_WEBHOOK`

Retrieve one CloudPDF webhook subscription by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Decimal webhook ID returned by create or list, such as 23. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `CLOUD_PDF_LIST_WEBHOOKS`

Return all webhook subscriptions configured for the connected CloudPDF organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `CLOUD_PDF_UPDATE_WEBHOOK`

Update selected fields of a CloudPDF webhook subscription without requiring unchanged values to be resent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | New public HTTPS callback URL; omission keeps the current value. |
| `name` | string | No | New webhook label; omission keeps the current value. |
| `events` | array | No | Complete replacement event-slug list; omission keeps current events and an empty list removes all events. |
| `secret` | string | No | New callback query-string secret; omission keeps the current value. |
| `headers` | object | No | Complete replacement callback-header map; omission keeps current headers and an empty object removes all headers. |
| `webhook_id` | string | Yes | Decimal webhook ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |