Create Monitor with UptimeRobot API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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,

Navigate to your UptimeRobot and sign in
Go to “My Settings” > “API Settings”

About UptimeRobot#

The world's leading uptime monitoring service.

More Ways to Connect UptimeRobot + Pipedream#

Other Popular Integrations#

Create Alert Contact with UptimeRobot API on New Scheduled Tasks from Pipedream API

Pipedream + UptimeRobot

Try it

Update Monitor Status with UptimeRobot API on New Scheduled Tasks from Pipedream API

Pipedream + UptimeRobot

Try it

Update Monitor Status with UptimeRobot API on Card Due Date Reminder from Pipedream API

Pipedream + UptimeRobot

Try it

Create Alert Contact with UptimeRobot API on Card Due Date Reminder from Pipedream API

Pipedream + UptimeRobot

Try it

Create Monitor with UptimeRobot API on Card Due Date Reminder from Pipedream API

Pipedream + UptimeRobot

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it