# Heyzine

Heyzine is a flipbook maker that converts PDFs into interactive, customizable digital publications with various page flip effects.

- **Category:** documents
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `HEYZINE`
- **Version:** 20260223_00

## Tools

### Create Flipbook Link

**Slug:** `HEYZINE_CREATE_FLIPBOOK_LINK`

Tool to create a direct flipbook link. Use when you have a document URL and want to convert it to a flipbook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `d` | string ("1" | "0") | No | Allow downloading original PDF (1 to allow, 0 to disallow) |
| `k` | string | Yes | Client ID or API key for authentication |
| `s` | string | No | Flipbook subtitle |
| `t` | string | No | Flipbook title |
| `bg` | string | No | Hex background color (e.g., ffffff) |
| `ds` | string | No | Flipbook description |
| `fs` | string ("1" | "0") | No | Show fullscreen button (1 to show, 0 to hide) |
| `lg` | string | No | Logo URL (Standard plan+) |
| `pn` | string ("1" | "0") | No | Show previous/next buttons (1 to show, 0 to hide) |
| `sh` | string ("1" | "0") | No | Show share button (1 to show, 0 to hide) |
| `st` | string ("1" | "0") | No | Show title/subtitle/description on background (1 to show, 0 to hide) |
| `pdf` | string | Yes | Direct URL to PDF/DOCX/PPTX; must be URL-encoded |
| `tpl` | string | No | Flipbook ID to copy design from (styles only) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 |

### Create Flipbook Asynchronously

**Slug:** `HEYZINE_CREATE_FLIPBOOK_REST_ASYNC`

Tool to create a flipbook asynchronously. Use when converting large documents off-thread; poll for updates on conversion state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pdf` | string | Yes | Direct URL to PDF/DOCX/PPTX; no redirects; URL-encoded |
| `logo` | string | No | URL of logo to place in the flipbook (Standard plan or higher) |
| `tags` | string | No | Comma-separated tags for organizing in the admin panel |
| `share` | boolean | No | Show share button (true to show) |
| `title` | string | No | Title for the flipbook and social sharing |
| `download` | boolean | No | Allow downloading the original PDF (true to allow) |
| `subtitle` | string | No | Subtitle for the flipbook and social sharing |
| `template` | string | No | Flipbook ID to copy design (logo, effect, background, controls, styles); does not copy access list or interactivity settings |
| `client_id` | string | Yes | Client ID for your Heyzine account |
| `prev_next` | boolean | No | Show previous/next buttons (true to show) |
| `show_info` | boolean | No | Show title/subtitle/description overlay (true to show) |
| `description` | string | No | Description for the flipbook and social sharing |
| `full_screen` | boolean | No | Show fullscreen button (true to show) |
| `private_note` | string | No | Internal note never shown to visitors; maps to 'private' in flipbook details |
| `background_color` | string | No | Hex color for solid background (6-digit, e.g. "000000" for black, "ffffff" for white) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 |

### Create Flipbook Sync

**Slug:** `HEYZINE_CREATE_FLIPBOOK_REST_SYNC`

Tool to convert a PDF, DOCX, or PPTX into a flipbook synchronously via REST API. Use when you need immediate flipbook URLs from a direct file link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pdf` | string | Yes | URL to the PDF/DOCX/PPTX to convert; must be a direct link with no redirects and URL-encoded. |
| `logo` | string | No | URL of the company logo (available on Standard plan and above). |
| `tags` | string | No | Comma-separated tags for organizing/filtering (e.g., "catalog,summer"). |
| `share` | boolean | No | If true, shows a share button. |
| `title` | string | No | Title displayed on the flipbook and on social shares. |
| `download` | boolean | No | If true, enables a download button for the original PDF. |
| `subtitle` | string | No | Subtitle displayed on the flipbook and on social shares. |
| `template` | string | No | Flipbook ID to copy design (logo, effect, background, controls, styles). Access list and interactions are not copied. |
| `client_id` | string | Yes | Your Heyzine client identifier as provided in your Heyzine dashboard. |
| `prev_next` | boolean | No | If true, shows previous/next page buttons. |
| `show_info` | boolean | No | If true, overlays title/subtitle/description on the flipbook background. |
| `description` | string | No | Description displayed on the flipbook and on social shares. |
| `full_screen` | boolean | No | If true, shows a fullscreen button. |
| `private_note` | string | No | Internal note not shown to visitors; corresponds to the flipbook’s ‘private’ field. |
| `background_color` | string | No | Solid hex color without "#" (e.g., "000000" or "ffffff"). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook

**Slug:** `HEYZINE_DELETE_FLIPBOOK`

Tool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the flipbook to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 API Limits

**Slug:** `HEYZINE_GET_API_LIMITS`

Tool to retrieve API rate limits. Use when you need to check your current API usage and limits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook ID Tool

**Slug:** `HEYZINE_GET_FLIPBOOK_ID_TOOL`

Tool to retrieve HTML for Flipbook ID tool. Use when you need to fetch the ID input tool page HTML for a specific flipbook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flipbook_id` | string | Yes | Identifier of the flipbook to retrieve ID tool HTML for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook List

**Slug:** `HEYZINE_GET_FLIPBOOK_LIST`

Tool to retrieve all flipbooks. Use when you need to list every flipbook for the authenticated account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Optional tag filter (if supported by API) |
| `page` | integer | No | Optional page number for pagination (if supported by API) |
| `limit` | integer | No | Optional page size limit (if supported by API) |
| `search` | string | No | Optional free-text search filter (if supported by API) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook Social Metadata

**Slug:** `HEYZINE_GET_FLIPBOOK_SOCIAL_METADATA`

Tool to retrieve social metadata for a specific flipbook. Use after configuring social sharing to fetch title, description, and thumbnail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flipbook_id` | string | Yes | Identifier of the flipbook to retrieve social metadata for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 jQuery Plugin

**Slug:** `HEYZINE_GET_J_QUERY_PLUGIN`

Tool to retrieve the Heyzine jQuery plugin script URL and usage snippet. Use when you need to integrate Heyzine flipbooks via jQuery on your website.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 oEmbed Data

**Slug:** `HEYZINE_GET_O_EMBED_API`

Tool to retrieve oEmbed data for a Heyzine flipbook. Use when you have a flipbook URL and need embed metadata and HTML.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Flipbook URL to fetch oEmbed data for |
| `format` | string | No | Response format; standard oEmbed parameter |
| `maxwidth` | integer | No | Maximum width for the embedded resource |
| `maxheight` | integer | No | Maximum height for the embedded resource |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 |

### Setup Heyzine Webhooks

**Slug:** `HEYZINE_SETUP_WEBHOOKS`

Helper tool to validate prerequisites for Heyzine webhooks. Heyzine does not expose an API to programmatically configure webhooks; this action verifies API connectivity and returns clear guidance to complete configuration in the Heyzine UI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event` | string | Yes | Type of event to subscribe to. Currently only 'leads' event is supported. |
| `frequency` | integer | Yes | Frequency in minutes at which Heyzine will send webhook events. |
| `endpoint_url` | string | Yes | External URL to receive Heyzine webhook notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook Access List

**Slug:** `HEYZINE_UPDATE_FLIPBOOK_ACCESS_LIST`

Tool to update the access list of a flipbook. Use when replacing all user access permissions in bulk.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `access_list` | array | Yes | List of access entries to set on the flipbook |
| `flipbook_id` | string | Yes | Identifier of the flipbook to update access for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook Password Protection

**Slug:** `HEYZINE_UPDATE_FLIPBOOK_PASSWORD_PROTECTION`

Tool to update flipbook password protection settings. Use when you need to change or disable password protection for a flipbook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("users" | "everyone" | "disabled") | Yes | Protection mode: 'users' for user-specific credentials, 'everyone' for a single shared password, or 'disabled' to turn off protection |
| `name` | string | Yes | Identifier of the flipbook to update password protection for |
| `password` | string | No | Shared password for all visitors; required when mode is 'everyone' |
| `text_user` | string | No | Custom text displayed on the username input prompt |
| `text_password` | string | No | Custom text displayed on the password input prompt |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 Flipbook Social Metadata

**Slug:** `HEYZINE_UPDATE_FLIPBOOK_SOCIAL_METADATA`

Tool to update a flipbook's social metadata. Use when you need to change title, description, or thumbnail for social sharing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title used for social sharing |
| `thumbnail` | string | No | URL of the image used as a thumbnail for social sharing |
| `description` | string | No | Description used for social sharing |
| `flipbook_id` | string | Yes | Identifier of the flipbook to update social metadata for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 |

### Heyzine Webhooks - Leads

**Slug:** `HEYZINE_WEBHOOKS_LEADS`

Tool to receive webhook events when new leads are collected on a flipbook form. Use after configuring your Heyzine account Webhooks > Leads URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Webhook event payload container |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | 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 |
