Heyzine | Composio Docs

Overview

SLUG: HEYZINE

Description

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

Authentication Details

API Key

generic_key

stringRequired

Connecting to Heyzine

Create an auth config

Use the dashboard to create an auth config for the Heyzine toolkit. This allows you to connect multiple Heyzine accounts to Composio for agents to use.

Select App

Navigate to Heyzine.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Heyzine Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 heyzine_auth_config_id = "ac_YOUR_HEYZINE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Heyzine for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, heyzine_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Heyzine toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["HEYZINE"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

HEYZINE_CREATE_FLIPBOOK_LINK

Tool Name: Create Flipbook Link

Description

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

Action Parameters

string

stringRequired

string

pdf

stringRequired

string

tpl

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_CREATE_FLIPBOOK_REST_ASYNC

Tool Name: Create Flipbook Asynchronously

Description

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

Action Parameters

background_color

string

client_id

stringRequired

description

string

download

boolean

full_screen

boolean

logo

string

pdf

stringRequired

prev_next

boolean

private_note

string

boolean

show_info

boolean

subtitle

string

HEYZINE_CREATE_FLIPBOOK_REST_SYNC

Tool Name: Create Flipbook Sync

Description

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.

Action Parameters

background_color

string

client_id

stringRequired

description

string

download

boolean

full_screen

boolean

logo

string

pdf

stringRequired

prev_next

boolean

private_note

string

boolean

show_info

boolean

subtitle

string

HEYZINE_DELETE_FLIPBOOK

Tool Name: Delete Flipbook

Description

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

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_API_LIMITS

Tool Name: Get API Limits

Description

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

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_FLIPBOOK_EMBED_CODE

Tool Name: Get Flipbook Embed Code

Description

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.

Action Parameters

flipbook_id

stringRequired

format

string

maxheight

integer

maxwidth

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_FLIPBOOK_ID_TOOL

Tool Name: Get Flipbook ID Tool

Description

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

Action Parameters

flipbook_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_FLIPBOOK_LIST

Tool Name: Get Flipbook List

Description

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

Action Parameters

limit

integer

page

integer

string

tag

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_FLIPBOOK_SOCIAL_METADATA

Tool Name: Get Flipbook Social Metadata

Description

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

Action Parameters

flipbook_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_J_QUERY_PLUGIN

Tool Name: Get jQuery Plugin

Description

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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_GET_O_EMBED_API

Tool Name: Get oEmbed Data

Description

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

Action Parameters

format

string

maxheight

integer

maxwidth

integer

url

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_HEYZINE_WEBHOOKS

Tool Name: Heyzine Webhooks

Description

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

Action Parameters

data

objectRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_SETUP_WEBHOOKS

Tool Name: Setup Heyzine Webhooks

Description

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.

Action Parameters

endpoint_url

stringRequired

event

stringRequired

frequency

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_UPDATE_FLIPBOOK_ACCESS_LIST

Tool Name: Update Flipbook Access List

Description

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

Action Parameters

access_list

arrayRequired

flipbook_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_UPDATE_FLIPBOOK_PASSWORD_PROTECTION

Tool Name: Update Flipbook Password Protection

Description

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

Action Parameters

mode

stringRequired

name

stringRequired

password

string

text_password

string

text_user

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_UPDATE_FLIPBOOK_SOCIAL_METADATA

Tool Name: Update Flipbook Social Metadata

Description

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

Action Parameters

description

string

flipbook_id

stringRequired

thumbnail

string

title

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

HEYZINE_WEBHOOKS_LEADS

Tool Name: Heyzine Webhooks - Leads

Description

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

Action Parameters

data

objectRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired