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

# Heyzine

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

![Heyzine logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/heyzine.ico?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=9e8a9ce7d5047fe5f19e9def4eb98460)

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

## Tools

> [accordion] 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
>
> **d** `string ("1" | "0")`
>
> Allow downloading original PDF (1 to allow, 0 to disallow)
>
> **k** `string` *required*
>
> Client ID or API key for authentication
>
> **s** `string`
>
> Flipbook subtitle
>
> **t** `string`
>
> Flipbook title
>
> **bg** `string`
>
> Hex background color (e.g., ffffff)
>
> **ds** `string`
>
> Flipbook description
>
> **fs** `string ("1" | "0")`
>
> Show fullscreen button (1 to show, 0 to hide)
>
> **lg** `string`
>
> Logo URL (Standard plan+)
>
> **pn** `string ("1" | "0")`
>
> Show previous/next buttons (1 to show, 0 to hide)
>
> **sh** `string ("1" | "0")`
>
> Show share button (1 to show, 0 to hide)
>
> **st** `string ("1" | "0")`
>
> Show title/subtitle/description on background (1 to show, 0 to hide)
>
> **pdf** `string` *required*
>
> Direct URL to PDF/DOCX/PPTX; must be URL-encoded
>
> **tpl** `string`
>
> Flipbook ID to copy design from (styles only)
>
> #### 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] Create Flipbook Asynchronously
>
> **Slug:** `HEYZINE_CREATE_FLIPBOOK_REST_ASYNC`
>
> Start an asynchronous flipbook conversion from a document URL and return the conversion state and flipbook details supplied in the response.
>
> #### Input Parameters
>
> **pdf** `string` *required*
>
> Direct URL to PDF/DOCX/PPTX; no redirects; URL-encoded
>
> **logo** `string`
>
> URL of logo to place in the flipbook (Standard plan or higher)
>
> **tags** `string`
>
> Comma-separated tags for organizing in the admin panel
>
> **share** `boolean`
>
> Show share button (true to show)
>
> **title** `string`
>
> Title for the flipbook and social sharing
>
> **download** `boolean`
>
> Allow downloading the original PDF (true to allow)
>
> **subtitle** `string`
>
> Subtitle for the flipbook and social sharing
>
> **template** `string`
>
> Flipbook ID to copy design (logo, effect, background, controls, styles); does not copy access list or interactivity settings
>
> **client\_id** `string` *required*
>
> Client ID for your Heyzine account
>
> **prev\_next** `boolean`
>
> Show previous/next buttons (true to show)
>
> **show\_info** `boolean`
>
> Show title/subtitle/description overlay (true to show)
>
> **description** `string`
>
> Description for the flipbook and social sharing
>
> **full\_screen** `boolean`
>
> Show fullscreen button (true to show)
>
> **private\_note** `string`
>
> Internal note never shown to visitors; maps to 'private' in flipbook details
>
> **background\_color** `string`
>
> Hex color for solid background (6-digit, e.g. "000000" for black, "ffffff" for white)
>
> #### 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] 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
>
> **pdf** `string` *required*
>
> URL to the PDF/DOCX/PPTX to convert; must be a direct link with no redirects and URL-encoded.
>
> **logo** `string`
>
> URL of the company logo (available on Standard plan and above).
>
> **tags** `string`
>
> Comma-separated tags for organizing/filtering (e.g., "catalog,summer").
>
> **share** `boolean`
>
> If true, shows a share button.
>
> **title** `string`
>
> Title displayed on the flipbook and on social shares.
>
> **download** `boolean`
>
> If true, enables a download button for the original PDF.
>
> **subtitle** `string`
>
> Subtitle displayed on the flipbook and on social shares.
>
> **template** `string`
>
> Flipbook ID to copy design (logo, effect, background, controls, styles). Access list and interactions are not copied.
>
> **client\_id** `string` *required*
>
> Your Heyzine client identifier as provided in your Heyzine dashboard.
>
> **prev\_next** `boolean`
>
> If true, shows previous/next page buttons.
>
> **show\_info** `boolean`
>
> If true, overlays title/subtitle/description on the flipbook background.
>
> **description** `string`
>
> Description displayed on the flipbook and on social shares.
>
> **full\_screen** `boolean`
>
> If true, shows a fullscreen button.
>
> **private\_note** `string`
>
> Internal note not shown to visitors; corresponds to the flipbook’s ‘private’ field.
>
> **background\_color** `string`
>
> Solid hex color without "#" (e.g., "000000" or "ffffff").
>
> #### 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 Flipbook
>
> **Slug:** `HEYZINE_DELETE_FLIPBOOK`
>
> Tool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the flipbook 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 API Limits
>
> **Slug:** `HEYZINE_GET_API_LIMITS`
>
> Probe a flipbook-list response for rate-limit headers and return any matching headers, the HTTP status and request ID. If no matching headers are present, the result includes a note.
>
> #### 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 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
>
> **flipbook\_id** `string` *required*
>
> Identifier of the flipbook to retrieve ID tool HTML for
>
> #### 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 Flipbook List
>
> **Slug:** `HEYZINE_GET_FLIPBOOK_LIST`
>
> Retrieve a list of flipbooks for the authenticated account, with optional page, limit, search and tag parameters when supported by the API.
>
> #### Input Parameters
>
> **tag** `string`
>
> Optional tag filter (if supported by API)
>
> **page** `integer`
>
> Optional page number for pagination (if supported by API)
>
> **limit** `integer`
>
> Optional page size limit (if supported by API)
>
> **search** `string`
>
> Optional free-text search filter (if supported by 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 Flipbook Social Metadata
>
> **Slug:** `HEYZINE_GET_FLIPBOOK_SOCIAL_METADATA`
>
> Retrieve a flipbook's title and thumbnail from an oEmbed response. The description field is returned as null.
>
> #### Input Parameters
>
> **flipbook\_id** `string` *required*
>
> Identifier of the flipbook to retrieve social metadata for
>
> #### 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 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
>
> **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] 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
>
> **event** `string` *required*
>
> Type of event to subscribe to. Currently only 'leads' event is supported.
>
> **frequency** `integer` *required*
>
> Frequency in minutes at which Heyzine will send webhook events.
>
> **endpoint\_url** `string` *required*
>
> External URL to receive Heyzine webhook notifications.
>
> #### 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 Flipbook Access List
>
> **Slug:** `HEYZINE_UPDATE_FLIPBOOK_ACCESS_LIST`
>
> Add access entries to a flipbook individually and return an aggregate result. The operation may partially complete if a later request fails.
>
> #### Input Parameters
>
> **access\_list** `array` *required*
>
> List of access entries to set on the flipbook
>
> **flipbook\_id** `string` *required*
>
> Identifier of the flipbook to update access for
>
> #### 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 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
>
> **mode** `string ("users" | "everyone" | "disabled")` *required*
>
> Protection mode: 'users' for user-specific credentials, 'everyone' for a single shared password, or 'disabled' to turn off protection
>
> **name** `string` *required*
>
> Identifier of the flipbook to update password protection for
>
> **password** `string`
>
> Shared password for all visitors; required when mode is 'everyone'
>
> **text\_user** `string`
>
> Custom text displayed on the username input prompt
>
> **text\_password** `string`
>
> Custom text displayed on the password input prompt
>
> #### 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 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
>
> **title** `string`
>
> Title used for social sharing
>
> **thumbnail** `string`
>
> URL of the image used as a thumbnail for social sharing
>
> **description** `string`
>
> Description used for social sharing
>
> **flipbook\_id** `string` *required*
>
> Identifier of the flipbook to update social metadata for
>
> #### 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] Heyzine Webhooks - Leads
>
> **Slug:** `HEYZINE_WEBHOOKS_LEADS`
>
> Validate a supplied Heyzine leads webhook payload and return a success acknowledgement with its webhook ID.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> Webhook event payload container
>
> #### 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
