NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Heyzine connects to a Nagent workspace with an API key. Once it is connected, agents can call 14 Heyzine actions, such as "Create Flipbook Link", "Create Flipbook Asynchronously" and "Create Flipbook Sync". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Heyzine, with input parameters and output schema.
HEYZINE_CREATE_FLIPBOOK_LINKTool to create a direct flipbook link. Use when you have a document URL and want to convert it to a flipbook.
Input parameters
Allow downloading original PDF (1 to allow, 0 to disallow)
Client ID or API key for authentication
Flipbook subtitle
Flipbook title
Hex background color (e.g., ffffff)
Flipbook description
Show fullscreen button (1 to show, 0 to hide)
Logo URL (Standard plan+)
Show previous/next buttons (1 to show, 0 to hide)
Show share button (1 to show, 0 to hide)
Show title/subtitle/description on background (1 to show, 0 to hide)
Direct URL to PDF/DOCX/PPTX; must be URL-encoded
Flipbook ID to copy design from (styles only)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_CREATE_FLIPBOOK_REST_ASYNCTool to create a flipbook asynchronously. Use when converting large documents off-thread; poll for updates on conversion state.
Input parameters
Direct URL to PDF/DOCX/PPTX; no redirects; URL-encoded
URL of logo to place in the flipbook (Standard plan or higher)
Comma-separated tags for organizing in the admin panel
Show share button (true to show)
Title for the flipbook and social sharing
Allow downloading the original PDF (true to allow)
Subtitle for the flipbook and social sharing
Flipbook ID to copy design (logo, effect, background, controls, styles); does not copy access list or interactivity settings
Client ID for your Heyzine account
Show previous/next buttons (true to show)
Show title/subtitle/description overlay (true to show)
Description for the flipbook and social sharing
Show fullscreen button (true to show)
Internal note never shown to visitors; maps to 'private' in flipbook details
Hex color for solid background (6-digit, e.g. "000000" for black, "ffffff" for white)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
URL to the PDF/DOCX/PPTX to convert; must be a direct link with no redirects and URL-encoded.
URL of the company logo (available on Standard plan and above).
Comma-separated tags for organizing/filtering (e.g., "catalog,summer").
If true, shows a share button.
Title displayed on the flipbook and on social shares.
If true, enables a download button for the original PDF.
Subtitle displayed on the flipbook and on social shares.
Flipbook ID to copy design (logo, effect, background, controls, styles). Access list and interactions are not copied.
Your Heyzine client identifier as provided in your Heyzine dashboard.
If true, shows previous/next page buttons.
If true, overlays title/subtitle/description on the flipbook background.
Description displayed on the flipbook and on social shares.
If true, shows a fullscreen button.
Internal note not shown to visitors; corresponds to the flipbook’s ‘private’ field.
Solid hex color without "#" (e.g., "000000" or "ffffff").
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_DELETE_FLIPBOOKTool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.
Input parameters
Unique identifier of the flipbook to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_GET_API_LIMITSTool to retrieve API rate limits. Use when you need to check your current API usage and limits.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Identifier of the flipbook to retrieve ID tool HTML for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_GET_FLIPBOOK_LISTTool to retrieve all flipbooks. Use when you need to list every flipbook for the authenticated account.
Input parameters
Optional tag filter (if supported by API)
Optional page number for pagination (if supported by API)
Optional page size limit (if supported by API)
Optional free-text search filter (if supported by API)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_GET_FLIPBOOK_SOCIAL_METADATATool to retrieve social metadata for a specific flipbook. Use after configuring social sharing to fetch title, description, and thumbnail.
Input parameters
Identifier of the flipbook to retrieve social metadata for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Type of event to subscribe to. Currently only 'leads' event is supported.
Frequency in minutes at which Heyzine will send webhook events.
External URL to receive Heyzine webhook notifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_UPDATE_FLIPBOOK_ACCESS_LISTTool to update the access list of a flipbook. Use when replacing all user access permissions in bulk.
Input parameters
List of access entries to set on the flipbook
Identifier of the flipbook to update access for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Protection mode: 'users' for user-specific credentials, 'everyone' for a single shared password, or 'disabled' to turn off protection
Identifier of the flipbook to update password protection for
Shared password for all visitors; required when mode is 'everyone'
Custom text displayed on the username input prompt
Custom text displayed on the password input prompt
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Title used for social sharing
URL of the image used as a thumbnail for social sharing
Description used for social sharing
Identifier of the flipbook to update social metadata for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYZINE_WEBHOOKS_LEADSTool to receive webhook events when new leads are collected on a flipbook form. Use after configuring your Heyzine account Webhooks > Leads URL.
Input parameters
Webhook event payload container
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 14 Heyzine actions on Nagent, including "Create Flipbook Link", "Create Flipbook Asynchronously" and "Create Flipbook Sync". Create Flipbook Link: Create a direct flipbook link. Each action is listed on this page with its input parameters and its output.
Heyzine connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Flipbook Link takes 2 required inputs: k and pdf. It also takes 11 optional inputs: d, s, t, bg, ds, fs, lg, pn, sh, st and tpl. It returns data, error and successful.