Create Post with Beekeeper API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Post with the Beekeeper 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 Beekeeper action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Post action
1. Connect your Beekeeper account
2. Select a Stream ID
3. Configure Text
4. Optional- Configure Files
5. Optional- Configure Locked
6. Optional- Configure Title
7. Optional- Configure Media
8. Optional- Configure Labels
9. Optional- Configure Sticky
10. Optional- Configure Reactions Disabled
11. Optional- Configure Options
12. Optional- Configure Scheduled At
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

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`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
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 Post on Beekeeper

Description:Create a new text or multimedia post in a defined stream. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/18408b41927b9-creates-a-new-post)

Version:0.0.1

Key:beekeeper-create-post

View on GitHub

Beekeeper Overview#

The Beekeeper API enables seamless integration of its workplace communications platform with other business tools and systems, enhancing team collaboration and operational efficiency. By leveraging the Beekeeper API on Pipedream, you can automate the flow of information between Beekeeper and various applications, trigger actions based on messages or alerts, and synchronize data across your organization's tools. Pipedream's serverless architecture simplifies the process of setting up these automations without the need for dedicated infrastructure.

Action Code#

import beekeeper from "../../beekeeper.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "beekeeper-create-post",
  name: "Create Post",
  description: "Create a new text or multimedia post in a defined stream. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/18408b41927b9-creates-a-new-post)",
  version: "0.0.1",
  type: "action",
  props: {
    beekeeper,
    streamId: {
      propDefinition: [
        beekeeper,
        "streamId",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "The text content of the post",
    },
    files: {
      type: "string[]",
      label: "Files",
      description: "List of file objects to be attached. E.g. [{\"name\": \"fair_play_rules.pdf\", \"url\": \"https://mytenant.beekeeper.io/file/665987/original/fair_play_rules.pdf\", \"userid\": \"5cb9v45d-8i78-4v65-b5fd-81cgfac3ef17\", \"height\": 619, \"width\": 700, \"key\": \"f4fdaab0-d198-49b4-b1cc-dd85572d72f1\", \"media_type\": \"image/png\", \"usage_type\": \"attachment_image\" }]. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/18408b41927b9-creates-a-new-post) for further details.",
      optional: true,
    },
    locked: {
      type: "boolean",
      label: "Locked",
      description: "Disables adding comments on the post",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the post",
      optional: true,
    },
    media: {
      type: "string[]",
      label: "Media",
      description: "List of Photo or Video objects. E.g. [{\"name\": \"fair_play_rules.pdf\", \"url\": \"https://mytenant.beekeeper.io/file/665987/original/fair_play_rules.pdf\", \"userid\": \"5cb9v45d-8i78-4v65-b5fd-81cgfac3ef17\", \"height\": 619, \"width\": 700, \"key\": \"f4fdaab0-d198-49b4-b1cc-dd85572d72f1\", \"media_type\": \"image/png\", \"usage_type\": \"attachment_image\" }]. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/18408b41927b9-creates-a-new-post) for further details.",
      optional: true,
    },
    labels: {
      type: "string[]",
      label: "Labels",
      description: "List of labels attached to the post",
      optional: true,
    },
    sticky: {
      type: "boolean",
      label: "Sticky",
      description: "Flag that pins a post to the top of the stream",
      optional: true,
    },
    reactionsDisabled: {
      type: "boolean",
      label: "Reactions Disabled",
      description: "Flag that disables the ability to add reaction to the post and to see reactions that have been added",
      optional: true,
    },
    options: {
      type: "string[]",
      label: "Options",
      description: "List of poll options in a post. E.g. [\"This Friday\", \"Monday next week\"]",
      optional: true,
    },
    scheduledAt: {
      type: "string",
      label: "Scheduled At",
      description: "Date and time when the post is scheduled to be published (UTC timezone, yyyy-mm-ddTHH:MM:SS format)",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.beekeeper.createPost({
      $,
      data: {
        streamid: this.streamId,
        files: parseObject(this.files),
        locked: this.locked,
        title: this.title,
        media: parseObject(this.media),
        labels: parseObject(this.labels),
        sticky: this.sticky,
        reactions_disabled: this.reactionsDisabled,
        text: this.text,
        options: parseObject(this.options)?.map((item) => ({
          text: item,
        })),
        scheduled_at: this.scheduledAt,
      },
    });

    $.export("$summary", `Successfully created post with UUID: ${response.uuid}`);
    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
Beekeeper	`beekeeper`	`app`	This component uses the Beekeeper app.
Stream ID	`streamId`	`string`	Select a value from the drop down menu.
Text	`text`	`string`	The text content of the post
Files	`files`	`string[]`	List of file objects to be attached. E.g. [{"name": "fair_play_rules.pdf", "url": "https://mytenant.beekeeper.io/file/665987/original/fair_play_rules.pdf", "userid": "5cb9v45d-8i78-4v65-b5fd-81cgfac3ef17", "height": 619, "width": 700, "key": "f4fdaab0-d198-49b4-b1cc-dd85572d72f1", "media_type": "image/png", "usage_type": "attachment_image" }]. See the documentation for further details.
Locked	`locked`	`boolean`	Disables adding comments on the post
Title	`title`	`string`	The title of the post
Media	`media`	`string[]`	List of Photo or Video objects. E.g. [{"name": "fair_play_rules.pdf", "url": "https://mytenant.beekeeper.io/file/665987/original/fair_play_rules.pdf", "userid": "5cb9v45d-8i78-4v65-b5fd-81cgfac3ef17", "height": 619, "width": 700, "key": "f4fdaab0-d198-49b4-b1cc-dd85572d72f1", "media_type": "image/png", "usage_type": "attachment_image" }]. See the documentation for further details.
Labels	`labels`	`string[]`	List of labels attached to the post
Sticky	`sticky`	`boolean`	Flag that pins a post to the top of the stream
Reactions Disabled	`reactionsDisabled`	`boolean`	Flag that disables the ability to add reaction to the post and to see reactions that have been added
Options	`options`	`string[]`	List of poll options in a post. E.g. ["This Friday", "Monday next week"]
Scheduled At	`scheduledAt`	`string`	Date and time when the post is scheduled to be published (UTC timezone, yyyy-mm-ddTHH:MM:SS format)