API_KEY
heyzine_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Heyzine API Keygeneric_key · stringRequired
HEYZINE
Heyzine is a flipbook maker that converts PDFs into interactive, customizable digital publications with various page flip effects.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
14
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–14 of 14 actions
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.
Untrusted display-only summary
HEYZINE_CREATE_FLIPBOOK_REST_ASYNC
Tool to create a flipbook asynchronously. Use when converting large documents off-thread; poll for updates on conversion state.
Untrusted display-only summary
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.
Untrusted display-only summary
HEYZINE_DELETE_FLIPBOOK
Tool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.
Untrusted display-only summary
HEYZINE_GET_API_LIMITS
Tool to retrieve API rate limits. Use when you need to check your current API usage and limits.
Untrusted display-only summary
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.
Untrusted display-only summary
HEYZINE_GET_FLIPBOOK_LIST
Tool to retrieve all flipbooks. Use when you need to list every flipbook for the authenticated account.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
HEYZINE_UPDATE_FLIPBOOK_ACCESS_LIST
Tool to update the access list of a flipbook. Use when replacing all user access permissions in bulk.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.