Skip to main content
Heyzine logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: HEYZINE
  • Version: 20261101_00

Tools

Slug: HEYZINE_CREATE_FLIPBOOK_REST_ASYNCStart an asynchronous flipbook conversion from a document URL and return the conversion state and flipbook details supplied in the response.

Input Parameters

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

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: HEYZINE_CREATE_FLIPBOOK_REST_SYNCTool 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

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

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: HEYZINE_DELETE_FLIPBOOKTool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.

Input Parameters

string
required
Unique identifier of the flipbook 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: HEYZINE_GET_API_LIMITSProbe 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

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: HEYZINE_GET_FLIPBOOK_ID_TOOLTool 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

string
required
Identifier of the flipbook to retrieve ID tool HTML for

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: HEYZINE_GET_FLIPBOOK_LISTRetrieve a list of flipbooks for the authenticated account, with optional page, limit, search and tag parameters when supported by the API.

Input Parameters

string
Optional tag filter (if supported by API)
integer
Optional page number for pagination (if supported by API)
integer
Optional page size limit (if supported by API)
Optional free-text search filter (if supported by 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: HEYZINE_GET_FLIPBOOK_SOCIAL_METADATARetrieve a flipbook’s title and thumbnail from an oEmbed response. The description field is returned as null.

Input Parameters

string
required
Identifier of the flipbook to retrieve social metadata for

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: HEYZINE_GET_J_QUERY_PLUGINTool 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

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: HEYZINE_SETUP_WEBHOOKSHelper 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

string
required
Type of event to subscribe to. Currently only ‘leads’ event is supported.
integer
required
Frequency in minutes at which Heyzine will send webhook events.
string
required
External URL to receive Heyzine webhook notifications.

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: HEYZINE_UPDATE_FLIPBOOK_ACCESS_LISTAdd access entries to a flipbook individually and return an aggregate result. The operation may partially complete if a later request fails.

Input Parameters

array
required
List of access entries to set on the flipbook
string
required
Identifier of the flipbook to update access for

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: HEYZINE_UPDATE_FLIPBOOK_PASSWORD_PROTECTIONTool to update flipbook password protection settings. Use when you need to change or disable password protection for a flipbook.

Input Parameters

string ("users" | "everyone" | "disabled")
required
Protection mode: ‘users’ for user-specific credentials, ‘everyone’ for a single shared password, or ‘disabled’ to turn off protection
string
required
Identifier of the flipbook to update password protection for
string
Shared password for all visitors; required when mode is ‘everyone’
string
Custom text displayed on the username input prompt
string
Custom text displayed on the password input prompt

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: HEYZINE_UPDATE_FLIPBOOK_SOCIAL_METADATATool to update a flipbook’s social metadata. Use when you need to change title, description, or thumbnail for social sharing.

Input Parameters

string
Title used for social sharing
string
URL of the image used as a thumbnail for social sharing
string
Description used for social sharing
string
required
Identifier of the flipbook to update social metadata for

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: HEYZINE_WEBHOOKS_LEADSValidate a supplied Heyzine leads webhook payload and return a success acknowledgement with its webhook ID.

Input Parameters

object
required
Webhook event payload container

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