# Heyzine

```json
{
  "name": "Heyzine",
  "slug": "heyzine",
  "url": "https://composio.dev/toolkits/heyzine",
  "markdown_url": "https://composio.dev/toolkits/heyzine.md",
  "logo_url": "https://heyzine.com/favicon.ico",
  "categories": [
    "marketing & social media"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:14:56.972Z"
}
```

![Heyzine logo](https://heyzine.com/favicon.ico)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Heyzine MCP or direct API to create flipbooks, update publication settings, fetch analytics, and share interactive links through natural language.

## Summary

Heyzine is a flipbook maker that turns static PDFs into interactive, customizable digital publications with page flip effects. It's perfect for engaging audiences with visually rich, professional digital magazines and catalogs.

## Categories

- marketing & social media

## Toolkit Details

- Tools: 14

## Images

- Logo: https://heyzine.com/favicon.ico

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Heyzine.
  - Setup:
    - Configure Api Key credentials for Heyzine.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Convert this PDF to a flipbook instantly
- Get embed code for my latest flipbook
- List all flipbooks I published this month
- Delete a flipbook by its name

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `HEYZINE_CREATE_FLIPBOOK_LINK` | 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. |
| `HEYZINE_CREATE_FLIPBOOK_REST_ASYNC` | Create Flipbook Asynchronously | Tool to create a flipbook asynchronously. Use when converting large documents off-thread; poll for updates on conversion state. |
| `HEYZINE_CREATE_FLIPBOOK_REST_SYNC` | Create Flipbook 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. |
| `HEYZINE_DELETE_FLIPBOOK` | Delete Flipbook | Tool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook. |
| `HEYZINE_GET_API_LIMITS` | Get API Limits | Tool to retrieve API rate limits. Use when you need to check your current API usage and limits. |
| `HEYZINE_GET_FLIPBOOK_ID_TOOL` | 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. |
| `HEYZINE_GET_FLIPBOOK_LIST` | Get Flipbook List | Tool to retrieve all flipbooks. Use when you need to list every flipbook for the authenticated account. |
| `HEYZINE_GET_FLIPBOOK_SOCIAL_METADATA` | Get Flipbook Social Metadata | Tool to retrieve social metadata for a specific flipbook. Use after configuring social sharing to fetch title, description, and thumbnail. |
| `HEYZINE_GET_J_QUERY_PLUGIN` | Get jQuery 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. |
| `HEYZINE_SETUP_WEBHOOKS` | Setup Heyzine 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. |
| `HEYZINE_UPDATE_FLIPBOOK_ACCESS_LIST` | Update Flipbook Access List | Tool to update the access list of a flipbook. Use when replacing all user access permissions in bulk. |
| `HEYZINE_UPDATE_FLIPBOOK_PASSWORD_PROTECTION` | Update Flipbook Password Protection | Tool to update flipbook password protection settings. Use when you need to change or disable password protection for a flipbook. |
| `HEYZINE_UPDATE_FLIPBOOK_SOCIAL_METADATA` | 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. |
| `HEYZINE_WEBHOOKS_LEADS` | 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. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Heyzine Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Heyzine actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Convert this PDF link to a flipbook with a magazine effect.'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Convert this PDF link to a flipbook with a magazine effect.'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Heyzine tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Create a flipbook link from https://example.com/marketing-brochure.pdf')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Create a flipbook link from https://example.com/marketing-brochure.pdf' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Heyzine Integration

- Supports both Heyzine MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for uploading PDFs, customizing flipbooks, and managing publications

### 2. Managed Auth

- Built-in API key storage and management for seamless Heyzine access
- Central dashboard to manage, scope, and revoke Heyzine credentials
- Per user and per environment keys instead of hard-coding anywhere

### 3. Agent Optimized Design

- Tools fine-tuned for high agent success with real-world user feedback
- Comprehensive logs for all PDF uploads, flipbook creations, and sharing events

### 4. Enterprise Grade Security

- Fine-grained RBAC ensures only designated agents can access flipbook creation or analytics
- Scoped, least privilege access to Heyzine publications and assets
- Full audit trail for all flipbook actions to support compliance

## Use Heyzine with any AI Agent Framework

Choose a framework you want to connect Heyzine with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/heyzine/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/heyzine/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/heyzine/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/heyzine/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/heyzine/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/heyzine/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/heyzine/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/heyzine/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/heyzine/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/heyzine/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/heyzine/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/heyzine/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/heyzine/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/heyzine/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/heyzine/framework/autogen)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.

## Frequently Asked Questions

### Do I need my own developer credentials to use Heyzine with Composio?

Yes, Heyzine requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)
