NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Heyzine

heyzine

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

DocumentsContent & FilesWeb del proveedor
Acciones
17
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (17)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Flipbook LinkHEYZINE_CREATE_FLIPBOOK_LINKAcción

Tool to create a direct flipbook link. Use when you have a document URL and want to convert it to a flipbook.

Parámetros de entrada

  • dstringenum

    Allow downloading original PDF (1 to allow, 0 to disallow)

    10
  • kstringObligatorio

    Client ID or API key for authentication

  • sstring

    Flipbook subtitle

  • tstring

    Flipbook title

  • bgstring

    Hex background color (e.g., ffffff)

  • dsstring

    Flipbook description

  • fsstringenum

    Show fullscreen button (1 to show, 0 to hide)

    10
  • lgstringuri

    Logo URL (Standard plan+)

  • pnstringenum

    Show previous/next buttons (1 to show, 0 to hide)

    10
  • shstringenum

    Show share button (1 to show, 0 to hide)

    10
  • ststringenum

    Show title/subtitle/description on background (1 to show, 0 to hide)

    10
  • pdfstringObligatoriouri

    Direct URL to PDF/DOCX/PPTX; must be URL-encoded

  • tplstring

    Flipbook ID to copy design from (styles only)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Flipbook AsynchronouslyHEYZINE_CREATE_FLIPBOOK_REST_ASYNCAcción

Tool to create a flipbook asynchronously. Use when converting large documents off-thread; poll for updates on conversion state.

Parámetros de entrada

  • pdfstringObligatorio

    Direct URL to PDF/DOCX/PPTX; no redirects; URL-encoded

  • logostring

    URL of logo to place in the flipbook (Standard plan or higher)

  • tagsstring

    Comma-separated tags for organizing in the admin panel

  • shareboolean

    Show share button (true to show)

  • titlestring

    Title for the flipbook and social sharing

  • downloadboolean

    Allow downloading the original PDF (true to allow)

  • subtitlestring

    Subtitle for the flipbook and social sharing

  • templatestring

    Flipbook ID to copy design (logo, effect, background, controls, styles); does not copy access list or interactivity settings

  • client_idstringObligatorio

    Client ID for your Heyzine account

  • prev_nextboolean

    Show previous/next buttons (true to show)

  • show_infoboolean

    Show title/subtitle/description overlay (true to show)

  • descriptionstring

    Description for the flipbook and social sharing

  • full_screenboolean

    Show fullscreen button (true to show)

  • private_notestring

    Internal note never shown to visitors; maps to 'private' in flipbook details

  • background_colorstring

    Hex color for solid background (6-digit, e.g. "000000" for black, "ffffff" for white)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Flipbook SyncHEYZINE_CREATE_FLIPBOOK_REST_SYNCAcción

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.

Parámetros de entrada

  • pdfstringObligatorio

    URL to the PDF/DOCX/PPTX to convert; must be a direct link with no redirects and URL-encoded.

  • logostring

    URL of the company logo (available on Standard plan and above).

  • tagsstring

    Comma-separated tags for organizing/filtering (e.g., "catalog,summer").

  • shareboolean

    If true, shows a share button.

  • titlestring

    Title displayed on the flipbook and on social shares.

  • downloadboolean

    If true, enables a download button for the original PDF.

  • subtitlestring

    Subtitle displayed on the flipbook and on social shares.

  • templatestring

    Flipbook ID to copy design (logo, effect, background, controls, styles). Access list and interactions are not copied.

  • client_idstringObligatorio

    Your Heyzine client identifier as provided in your Heyzine dashboard.

  • prev_nextboolean

    If true, shows previous/next page buttons.

  • show_infoboolean

    If true, overlays title/subtitle/description on the flipbook background.

  • descriptionstring

    Description displayed on the flipbook and on social shares.

  • full_screenboolean

    If true, shows a fullscreen button.

  • private_notestring

    Internal note not shown to visitors; corresponds to the flipbook’s ‘private’ field.

  • background_colorstring

    Solid hex color without "#" (e.g., "000000" or "ffffff").

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete FlipbookHEYZINE_DELETE_FLIPBOOKAcción

Tool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the flipbook to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get API LimitsHEYZINE_GET_API_LIMITSAcción

Tool to retrieve API rate limits. Use when you need to check your current API usage and limits.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Flipbook Embed CodeHEYZINE_GET_FLIPBOOK_EMBED_CODEAcción

Tool to retrieve HTML embed code for a flipbook. Use when you have a flipbook ID and need the <iframe> snippet to embed in a website.

Parámetros de entrada

  • formatstringenum

    Response format (json or xml)

    jsonxml
  • maxwidthinteger

    Maximum width of returned embed, in pixels

  • maxheightinteger

    Maximum height of returned embed, in pixels

  • flipbook_idstringObligatorio

    Identifier of the flipbook to retrieve embed code for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Flipbook ID ToolHEYZINE_GET_FLIPBOOK_ID_TOOLAcción

Tool to retrieve HTML for Flipbook ID tool. Use when you need to fetch the ID input tool page HTML for a specific flipbook.

Parámetros de entrada

  • flipbook_idstringObligatorio

    Identifier of the flipbook to retrieve ID tool HTML for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Flipbook ListHEYZINE_GET_FLIPBOOK_LISTAcción

Tool to retrieve all flipbooks. Use when you need to list every flipbook for the authenticated account.

Parámetros de entrada

  • tagstring

    Optional tag filter (if supported by API)

  • pageinteger

    Optional page number for pagination (if supported by API)

  • limitinteger

    Optional page size limit (if supported by API)

  • searchstring

    Optional free-text search filter (if supported by API)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Flipbook Social MetadataHEYZINE_GET_FLIPBOOK_SOCIAL_METADATAAcción

Tool to retrieve social metadata for a specific flipbook. Use after configuring social sharing to fetch title, description, and thumbnail.

Parámetros de entrada

  • flipbook_idstringObligatorio

    Identifier of the flipbook to retrieve social metadata for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get jQuery PluginHEYZINE_GET_J_QUERY_PLUGINAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get oEmbed DataHEYZINE_GET_O_EMBED_APIAcción

Tool to retrieve oEmbed data for a Heyzine flipbook. Use when you have a flipbook URL and need embed metadata and HTML.

Parámetros de entrada

  • urlstringObligatoriouri

    Flipbook URL to fetch oEmbed data for

  • formatstring

    Response format; standard oEmbed parameter

  • maxwidthinteger

    Maximum width for the embedded resource

  • maxheightinteger

    Maximum height for the embedded resource

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Heyzine WebhooksHEYZINE_HEYZINE_WEBHOOKSAcción

Tool to receive Heyzine webhook events for collected leads. Use after configuring your Heyzine account Webhooks URL.

Parámetros de entrada

  • dataobjectObligatorio

    Webhook event payload container

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Setup Heyzine WebhooksHEYZINE_SETUP_WEBHOOKSAcción

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.

Parámetros de entrada

  • eventstringObligatorio

    Type of event to subscribe to. Currently only 'leads' event is supported.

  • frequencyintegerObligatorio

    Frequency in minutes at which Heyzine will send webhook events.

  • endpoint_urlstringObligatoriouri

    External URL to receive Heyzine webhook notifications.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Flipbook Access ListHEYZINE_UPDATE_FLIPBOOK_ACCESS_LISTAcción

Tool to update the access list of a flipbook. Use when replacing all user access permissions in bulk.

Parámetros de entrada

  • access_listobject[]Obligatorio

    List of access entries to set on the flipbook

  • flipbook_idstringObligatorio

    Identifier of the flipbook to update access for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Flipbook Password ProtectionHEYZINE_UPDATE_FLIPBOOK_PASSWORD_PROTECTIONAcción

Tool to update flipbook password protection settings. Use when you need to change or disable password protection for a flipbook.

Parámetros de entrada

  • modestringObligatorioenum

    Protection mode: 'users' for user-specific credentials, 'everyone' for a single shared password, or 'disabled' to turn off protection

    userseveryonedisabled
  • namestringObligatorio

    Identifier of the flipbook to update password protection for

  • passwordstring

    Shared password for all visitors; required when mode is 'everyone'

  • text_userstring

    Custom text displayed on the username input prompt

  • text_passwordstring

    Custom text displayed on the password input prompt

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Flipbook Social MetadataHEYZINE_UPDATE_FLIPBOOK_SOCIAL_METADATAAcción

Tool to update a flipbook's social metadata. Use when you need to change title, description, or thumbnail for social sharing.

Parámetros de entrada

  • titlestring

    Title used for social sharing

  • thumbnailstringuri

    URL of the image used as a thumbnail for social sharing

  • descriptionstring

    Description used for social sharing

  • flipbook_idstringObligatorio

    Identifier of the flipbook to update social metadata for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Heyzine Webhooks - LeadsHEYZINE_WEBHOOKS_LEADSAcción

Tool to receive webhook events when new leads are collected on a flipbook form. Use after configuring your Heyzine account Webhooks > Leads URL.

Parámetros de entrada

  • dataobjectObligatorio

    Webhook event payload container

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not