Create Flipbook with Heyzine API on New Package Version from npm API

Pipedream makes it easy to connect APIs for Heyzine, npm and 2,200+ other apps remarkably fast.

Trigger workflow on

New Package Version from the npm API

Next, do this

Create Flipbook with the Heyzine API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a npm trigger and Heyzine action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Create Flipbook action
1. Connect your Heyzine account
2. Configure PDF
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Flipbook on Heyzine

Description:Generates a new flipbook from a PDF file. [See the documentation](https://heyzine.com/developers#rest-api)

Version:0.0.1

Key:heyzine-create-flipbook

View on GitHub

Heyzine Overview#

Heyzine API allows users to create and manage interactive, digital flipbooks from PDFs. With this API, you can automate the conversion of documents into engaging flipbooks, update existing flipbooks, manage pages, and integrate viewer statistics into analytics tools. Using Pipedream, you can harness this API to automate workflows, such as generating marketing materials, creating reports from data, or disseminating information in a visually appealing format.

Action Code#

import heyzine from "../../heyzine.app.mjs";

export default {
  key: "heyzine-create-flipbook",
  name: "Create Flipbook",
  description: "Generates a new flipbook from a PDF file. [See the documentation](https://heyzine.com/developers#rest-api)",
  version: "0.0.1",
  type: "action",
  props: {
    heyzine,
    pdf: {
      type: "string",
      label: "PDF",
      description: "Url pointing to the pdf to be converted. Must be a direct link to a PDF file.",
    },
  },
  async run({ $ }) {
    const response = await this.heyzine.makeRequest({
      $,
      params: {
        pdf: this.pdf,
      },
    });
    $.export("$summary", `Successfully created a new flipbook with ID: ${response.id}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Heyzine	`heyzine`	`app`	This component uses the Heyzine app.
PDF	`pdf`	`string`	Url pointing to the pdf to be converted. Must be a direct link to a PDF file.

Action Authentication#

Heyzine uses API keys for authentication. When you connect your Heyzine account, Pipedream securely stores the keys so you can easily authenticate to Heyzine APIs in both code and no-code steps.

To retrieve your API key,