Create Monitor with UptimeRobot API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Monitor with the UptimeRobot 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 UptimeRobot 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 Monitor action
1. Connect your UptimeRobot account
2. Select a Monitor Type
3. Configure Friendly Name
4. Configure URL, IP Or Host
5. Select a Monitor Interval
6. Select one or more Alert Contacts
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 Monitor on UptimeRobot

Description:Create a new monitor. [See the documentation](https://uptimerobot.com/api/).

Version:0.0.1

Key:uptimerobot-create-monitor

View on GitHub

UptimeRobot Overview#

The UptimeRobot API allows you to monitor the uptime of websites and services, sending alerts for any downtime detected. With Pipedream, you can harness this API to create tailored notifications, generate uptime reports, and synchronize with incident management tools. By leveraging Pipedream's capabilities, you can integrate UptimeRobot with a myriad of services to automate responses to uptime changes, streamline communication processes, and maintain a pulse on your web infrastructure's health.

Action Code#

import constants from "../../common/constants.mjs";
import app from "../../uptimerobot.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "uptimerobot-create-monitor",
  name: "Create Monitor",
  description: "Create a new monitor. [See the documentation](https://uptimerobot.com/api/).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    type: {
      type: "string",
      label: "Monitor Type",
      description: "The type of the monitor.",
      reloadProps: true,
      default: constants.MONITOR_TYPE.PING.value,
      options: Object.values(constants.MONITOR_TYPE),
    },
    friendlyName: {
      description: "A friendly name for the monitor.",
      propDefinition: [
        app,
        "friendlyName",
      ],
    },
    url: {
      type: "string",
      label: "URL, IP Or Host",
      description: "The URL, IP address or Host to monitor.",
    },
    interval: {
      type: "string",
      label: "Monitor Interval",
      description: "The interval for the monitoring check in seconds. It is recommended to use at least 1-minute checks [available in paid plans](https://app.uptimerobot.com/billing/pricing).",
      default: String(5 * 60),
      options: [
        {
          label: "5 Minutes",
          value: String(5 * 60),
        },
        {
          label: "30 Minutes",
          value: String(30 * 60),
        },
        {
          label: "1 Hour",
          value: String(60 * 60),
        },
        {
          label: "12 Hours",
          value: String(12 * 60 * 60),
        },
        {
          label: "1 Day",
          value: String(24 * 60 * 60),
        },
      ],
    },
    alertContacts: {
      type: "string[]",
      label: "Alert Contacts",
      propDefinition: [
        app,
        "alertContact",
      ],
    },
  },
  additionalProps() {
    const {
      type: monitorType,
      subType,
    } = this;

    const timeout = {
      type: "string",
      label: "Request Timeout",
      description: "The request timeout. The shorter the timeout the earlier we mark website as down.",
      default: "30",
      options: [
        {
          label: "1 Second",
          value: "1",
        },
        {
          label: "15 Seconds",
          value: "15",
        },
        {
          label: "30 Seconds",
          value: "30",
        },
        {
          label: "45 Seconds",
          value: "45",
        },
        {
          label: "1 Minute",
          value: "60",
        },
      ],
    };

    const authProps = {
      httpAuthType: {
        type: "string",
        label: "HTTP Auth Type",
        description: "The HTTP auth type for the monitor.",
        optional: true,
        options: [
          {
            label: "HTTP Basic",
            value: "1",
          },
          {
            label: "Digest",
            value: "2",
          },
        ],
      },
      httpUsername: {
        type: "string",
        label: "HTTP Username",
        description: "The HTTP username for the monitor.",
        optional: true,
      },
      httpPassword: {
        type: "string",
        label: "HTTP Password",
        description: "The HTTP password for the monitor.",
        optional: true,
      },
    };

    if (monitorType === constants.MONITOR_TYPE.PORT.value) {
      return {
        timeout,
        subType: {
          type: "string",
          label: "Port Type",
          description: "The type of the port.",
          options: Object.values(constants.PORT_TYPE),
          default: constants.PORT_TYPE.HTTP.value,
          reloadProps: true,
        },
        ...(subType === constants.PORT_TYPE.CUSTOM.value && {
          port: {
            type: "string",
            label: "Port",
            description: "The port number to monitor.",
          },
        }),
      };
    }

    if (monitorType === constants.MONITOR_TYPE.KEYWORD.value) {
      return {
        keywordValue: {
          type: "string",
          label: "Keyword Value",
          description: "The keyword must be present in the response HTML source. You can use HTML markup, too. Eg. `apple` or `<span id=\"availability\">Out of stock</span>`.",
        },
        keywordType: {
          type: "string",
          label: "Keyword Type",
          description: "The keyword type of the monitor.",
          default: "1",
          options: [
            {
              label: "Start incident when keyword exists",
              value: "1",
            },
            {
              label: "Start incident when keyword does not exist",
              value: "2",
            },
          ],
        },
        keywordCaseType: {
          type: "string",
          label: "Keyword Case Type",
          description: "The keyword case type of the monitor.",
          default: "1",
          options: [
            {
              label: "Case Sensitive",
              value: "0",
            },
            {
              label: "Case Insensitive",
              value: "1",
            },
          ],
        },
        ...authProps,
      };
    }

    if (monitorType === constants.MONITOR_TYPE.HTTPS.value) {
      return {
        timeout,
        ...authProps,
      };
    }

    return {};
  },
  methods: {
    formatAlertContacts(alertContacts, useDefaultThresholdAndRecurrence = true) {
      const threshold = 0;
      const recurrence = 0;
      return utils.parseArray(alertContacts)
        ?.map((value) => useDefaultThresholdAndRecurrence
          ? `${value}_${threshold}_${recurrence}`
          : value)
        .join("-");
    },
    createMonitor(args = {}) {
      return this.app.post({
        path: "/newMonitor",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createMonitor,
      formatAlertContacts,
      type,
      friendlyName,
      url,
      interval,
      alertContacts,
      timeout,
      subType,
      port,
      keywordType,
      keywordValue,
      keywordCaseType,
      httpUsername,
      httpPassword,
      httpAuthType,
    } = this;

    const response = await createMonitor({
      $,
      data: {
        friendly_name: friendlyName,
        url,
        type,
        interval,
        alert_contacts: formatAlertContacts(alertContacts),
        timeout,
        sub_type: subType,
        port,
        keyword_type: keywordType,
        keyword_value: keywordValue,
        keyword_case_type: keywordCaseType,
        http_username: httpUsername,
        http_password: httpPassword,
        http_auth_type: httpAuthType,
      },
    });

    $.export("$summary", `Successfully created monitor with ID \`${response.monitor.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
UptimeRobot	`app`	`app`	This component uses the UptimeRobot app.
Monitor Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Ping", "value": "3" }{ "label": "Port", "value": "4" }{ "label": "HTTP(s)", "value": "1" }{ "label": "Keyword", "value": "2" }`
Friendly Name	`friendlyName`	`string`	A friendly name for the monitor.
URL, IP Or Host	`url`	`string`	The URL, IP address or Host to monitor.
Monitor Interval	`interval`	`string`	Select a value from the drop down menu:`{ "label": "5 Minutes", "value": "300" }{ "label": "30 Minutes", "value": "1800" }{ "label": "1 Hour", "value": "3600" }{ "label": "12 Hours", "value": "43200" }{ "label": "1 Day", "value": "86400" }`
Alert Contacts	`alertContacts`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API keys,