Throw Error with Error API on Incident Updated (Instant) from Statuspage API

Pipedream makes it easy to connect APIs for Error, Statuspage and 3,000+ other apps remarkably fast.

Trigger workflow on

Incident Updated (Instant) from the Statuspage API

Next, do this

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

Select this integration
Configure the Incident Updated (Instant) trigger
1. Connect your Statuspage account
2. Select a Page ID
3. Select one or more Component IDs
4. Configure Email
Configure the Throw Error action
1. Connect your Error account
2. Configure Error Name
3. Optional- Configure Error Message
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#

Incident Updated (Instant) on Statuspage

Description:Emit new event on each updated incident.

Version:0.0.3

Key:statuspage-incident-updated

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.

Trigger Code#

import common from "../common/common.mjs";

export default {
  ...common,
  name: "Incident Updated (Instant)",
  version: "0.0.3",
  key: "statuspage-incident-updated",
  description: "Emit new event on each updated incident.",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async deploy() {
      const incidents = await this.statuspage.getIncidents({
        pageId: this.pageId,
        params: {
          limit: 20,
        },
      });

      incidents.reverse().forEach(this.emitEvent);
    },
    emitEvent(event) {
      const data = event?.incident ?? event;

      if (data.incident_updates.length <= 1) {
        return;
      }

      this.$emit(data, {
        id: `${data.id}-${Date.parse(data.updated_at)}`,
        summary: `New incident updated with id ${data.id}`,
        ts: Date.parse(data.created_at),
      });
    },
  },
};

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
Statuspage	`statuspage`	`app`	This component uses the Statuspage app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Page ID	`pageId`	`string`	Select a value from the drop down menu.
Component IDs	`componentIds`	`string[]`	Select a value from the drop down menu.
Email	`email`	`string`	We'll send an email to this address if the endpoint fails

Trigger 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.

About Statuspage#

Easily communicate real-time status to your users

Action#

Throw Error on Error

Description:Quickly throw an error from your workflow.

Version:0.0.2

Key:error-throw-error

View on GitHub

Action Code#

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

export default {
  name: "Throw Error",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  key: "error-throw-error",
  description: "Quickly throw an error from your workflow.",
  props: {
    error,
    name: {
      propDefinition: [
        error,
        "name",
      ],
    },
    errorMessage: {
      propDefinition: [
        error,
        "errorMessage",
      ],
    },
  },
  type: "action",
  async run() {
    this.error.maybeCreateAndThrowError(this.name, this.errorMessage);
  },
};

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
Error	`error`	`app`	This component uses the Error app.
Error Name	`name`	`string`	The name (class) of error to throw, which you can define as any custom string. This will show up in all of the standard Pipedream error handling destinations.
Error Message	`errorMessage`	`string`	The error message to throw. This will show up in all of the standard Pipedream error handling destinations.