Developer Docs

Everything you need to integrate ZenFlip into your product: REST API, embed widget, webhooks, and more.

Welcome

The ZenFlip developer docs cover everything from getting started with your first publication to advanced API integrations. Choose a topic from the sidebar, or browse the sections below.

Getting Started

Quick Start Guide

Get up and running with the ZenFlip API in under five minutes. Create your first API key, authenticate, and list your publications.

Authentication

Learn how to authenticate with the ZenFlip API using JWT tokens, refresh tokens, and Google OAuth. API keys for server-to-server communication are coming soon.

API Reference

Publications API

Create, update, delete, and manage flipbook publications. Upload PDFs, control visibility, manage versions, and generate QR codes.

Analytics API

Track viewer engagement and retrieve analytics data including page views, unique viewers, read time, geographic breakdown, and device statistics.

Lead Capture API

Build and manage lead capture forms, collect viewer submissions from your publications, and export lead data as CSV.

Teams API

Manage your organization's team members. Invite collaborators, assign roles, update permissions, and remove members.

Embed Widget

Embed Widget Quick Start

Add interactive flipbook publications to any website with a single script tag. Covers basic embedding, data attributes, and troubleshooting common issues.

Advanced Embed Options

Use the programmatic JavaScript API for dynamic embedding, integrate with React/Vue/Angular SPAs, handle events, customize styling, and configure auto-flip behavior.

Webhooks

Webhooks Overview

Receive real-time notifications when events occur in your ZenFlip organization. Learn how to register webhook URLs, verify signatures, and handle retries.

Webhook Event Reference

Detailed payload schemas and example JSON for every ZenFlip webhook event type, including request headers and a Node.js signature verification example.