Create Incident with Better Stack API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Incident with the Better Stack 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 Better Stack 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 Incident action
1. Connect your Better Stack account
2. Configure Requester Email
3. Configure Summary
4. Optional- Configure Name
5. Optional- Configure Description
6. Optional- Configure Call
7. Optional- Configure SMS
8. Optional- Configure Email
9. Optional- Configure Push
10. Optional- Configure Team Wait
11. Optional- Select a Policy ID
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 Incident on Better Stack

Description:Initiates an incident that signals the team. [See the documentation](https://betterstack.com/docs/uptime/api/create-a-new-incident/)

Version:0.0.1

Key:better_stack-create-incident

View on GitHub

Better Stack Overview#

The Better Stack API allows you to enhance your app's capabilities with powerful monitoring, logging, and analytics tools. By connecting to the API through Pipedream, you can create custom, serverless workflows that automate the ingestion, analysis, and response to your app's operational data. Leverage real-time insights, set up alerts, and integrate with various other services to maintain optimal performance and swiftly troubleshoot issues.

Action Code#

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

export default {
  key: "better_stack-create-incident",
  name: "Create Incident",
  description: "Initiates an incident that signals the team. [See the documentation](https://betterstack.com/docs/uptime/api/create-a-new-incident/)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    requesterEmail: {
      type: "string",
      label: "Requester Email",
      description: "E-mail of the user who requested the incident",
    },
    summary: {
      type: "string",
      label: "Summary",
      description: "Brief summary of the incident",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Short name of the incident",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "Full description of the incident",
      optional: true,
    },
    call: {
      type: "boolean",
      label: "Call",
      description: "Should we call the on-call person?",
      optional: true,
    },
    sms: {
      type: "boolean",
      label: "SMS",
      description: "Should we send an SMS to the on-call person?",
      optional: true,
    },
    email: {
      type: "boolean",
      label: "Email",
      description: "Should we send an email to the on-call person?",
      optional: true,
    },
    push: {
      type: "boolean",
      label: "Push",
      description: "Should we send a push notification to the on-call person?",
      optional: true,
    },
    teamWait: {
      type: "integer",
      label: "Team Wait",
      description: "How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.",
      optional: true,
    },
    policyId: {
      propDefinition: [
        app,
        "policyId",
      ],
    },
  },
  methods: {
    createIncident(args = {}) {
      return this.app.post({
        path: "/incidents",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createIncident,
      requesterEmail,
      name,
      summary,
      description,
      call,
      sms,
      email,
      push,
      teamWait,
      policyId,
    } = this;

    const response = await createIncident({
      $,
      data: {
        requester_email: requesterEmail,
        name,
        summary,
        description,
        call,
        sms,
        email,
        push,
        team_wait: teamWait,
        policy_id: policyId,
      },
    });

    $.export("$summary", `Successfully created incident with ID \`${response.data.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
Better Stack	`app`	`app`	This component uses the Better Stack app.
Requester Email	`requesterEmail`	`string`	E-mail of the user who requested the incident
Summary	`summary`	`string`	Brief summary of the incident
Name	`name`	`string`	Short name of the incident
Description	`description`	`string`	Full description of the incident
Call	`call`	`boolean`	Should we call the on-call person?
SMS	`sms`	`boolean`	Should we send an SMS to the on-call person?
Email	`email`	`boolean`	Should we send an email to the on-call person?
Push	`push`	`boolean`	Should we send a push notification to the on-call person?
Team Wait	`teamWait`	`integer`	How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. In seconds.
Policy ID	`policyId`	`string`	Select a value from the drop down menu.