Create Incident with Statuspage API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Incident action
1. Connect your Statuspage account
2. Select a Page ID
3. Configure Name
4. Select a Status
5. Configure Message
6. Optional- Select one or more Component IDs
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#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Incident on Statuspage

Description:Creates an incident. [See docs here](https://developer.statuspage.io/#create-an-incident)

Version:0.0.2

Key:statuspage-create-incident

View on GitHub

Statuspage Overview#

The Statuspage API allows you to automate the management and orchestration of incident communication directly from Pipedream. With this API, you can create, update, and resolve incidents, manage maintenance events, and retrieve information about components and subscribers. It's an efficient way to ensure transparency and inform stakeholders during outages or scheduled maintenance by programmatically controlling your status pages.

Action Code#

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

export default {
  name: "Create Incident",
  version: "0.0.2",
  key: "statuspage-create-incident",
  description: "Creates an incident. [See docs here](https://developer.statuspage.io/#create-an-incident)",
  type: "action",
  props: {
    statuspage,
    pageId: {
      propDefinition: [
        statuspage,
        "pageId",
      ],
    },
    name: {
      label: "Name",
      description: "The name of the incident",
      type: "string",
    },
    status: {
      propDefinition: [
        statuspage,
        "status",
      ],
    },
    message: {
      label: "Message",
      description: "The description of the incident",
      type: "string",
    },
    componentIds: {
      label: "Component IDs",
      description: "The IDs of the component that will be affected",
      type: "string[]",
      propDefinition: [
        statuspage,
        "componentId",
        (c) => ({
          pageId: c.pageId,
        }),
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.statuspage.createIncident({
      $,
      pageId: this.pageId,
      data: {
        incident: {
          name: this.name,
          status: this.status,
          message: this.message,
          component_ids: this.componentIds,
        },
      },
    });

    if (response) {
      $.export("$summary", `Successfully created incident 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
Statuspage	`statuspage`	`app`	This component uses the Statuspage app.
Page ID	`pageId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the incident
Status	`status`	`string`	Select a value from the drop down menu:`investigatingidentifiedmonitoringresolved`
Message	`message`	`string`	The description of the incident
Component IDs	`componentIds`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

Follow these instructions to find your API key, and enter it below.

On that same page, you'll see a list of page IDs. Enter the ID of the page you'd like to manage below.