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.
Write ActionRisk level 2 of 5API key connectionFree Action
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.
pdfRequiredstringURL to the PDF/DOCX/PPTX to convert; must be a direct link with no redirects and URL-encoded.
logostringURL of the company logo (available on Standard plan and above).
tagsstringComma-separated tags for organizing/filtering (e.g., "catalog,summer").
sharebooleanIf true, shows a share button.
titlestringTitle displayed on the flipbook and on social shares.
downloadbooleanIf true, enables a download button for the original PDF.
subtitlestringSubtitle displayed on the flipbook and on social shares.
templatestringFlipbook ID to copy design (logo, effect, background, controls, styles). Access list and interactions are not copied.
client_idRequiredstringYour Heyzine client identifier as provided in your Heyzine dashboard.
prev_nextbooleanIf true, shows previous/next page buttons.
show_infobooleanIf true, overlays title/subtitle/description on the flipbook background.
descriptionstringDescription displayed on the flipbook and on social shares.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.