Heyzine

Heyzine integration (Design & Media, Productivity). Imported from open-connector.

API key9 toolshttps://heyzine.com

GET

heyzine_list_flipbooks

List the flipbooks accessible with the current Heyzine API key.

/api1/flipbook-list

GET

heyzine_get_flipbook

Get the details and oEmbed metadata for a specific Heyzine flipbook.

/api1/flipbook-get

1 parameter

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.

POST

heyzine_delete_flipbook

Delete a specific Heyzine flipbook.

/api1/flipbook-delete

1 parameter

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.

GET

heyzine_list_bookshelves

List the bookshelves accessible with the current Heyzine API key.

/api1/bookshelf-list

GET

heyzine_list_bookshelf_flipbooks

List the flipbooks assigned to a specific Heyzine bookshelf.

/api1/bookshelf-get

1 parameter

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.

POST

heyzine_add_flipbook_to_bookshelf

Add a flipbook to a specific Heyzine bookshelf.

/api1/bookshelf-add

3 parameters

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.
flipbook_id	string	required	The Heyzine flipbook identifier.
position	integer	optional	The optional 0-based position inside the bookshelf.

POST

heyzine_remove_flipbook_from_bookshelf

Remove a flipbook from a specific Heyzine bookshelf.

/api1/bookshelf-remove

2 parameters

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.
flipbook_id	string	required	The Heyzine flipbook identifier.

POST

heyzine_set_flipbook_social_data

Set the social sharing metadata for a specific Heyzine flipbook.

/api1/flipbook-social

4 parameters

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.
title	string	optional	The optional social sharing title.
description	string	optional	The optional social sharing description.
thumbnail	string	optional	The URL for the social sharing thumbnail image.

POST

heyzine_set_bookshelf_social_data

Set the social sharing metadata for a specific Heyzine bookshelf.

/api1/bookshelf-social

4 parameters

Param	Type	Required	Description
id	string	required	The Heyzine flipbook or bookshelf identifier.
title	string	optional	The optional social sharing title.
description	string	optional	The optional social sharing description.
thumbnail	string	optional	The URL for the social sharing thumbnail image.