Create Incident with Statuspage API on New Event from ChatBot API

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

Trigger workflow on

New Event from the ChatBot API

Next, do this

Create Incident with the Statuspage API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a ChatBot 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 New Event trigger
1. Connect your ChatBot account
2. Optional- Configure Webhook Name
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#

New Event on ChatBot

Description:Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)

Version:0.0.1

Key:chatbot-new-event

View on GitHub

ChatBot Overview#

Leverage the ChatBot API on Pipedream to automate conversations, streamline customer service, and connect chat functionality with various apps for rich, responsive interaction. With this API, you can programmatically send messages, manage chat histories, and implement chatbots that react to user input in real-time. By integrating with Pipedream, these capabilities can be augmented with thousands of apps, enabling seamless data flow and complex automations.

Trigger Code#

import chatbot from "../../chatbot.app.mjs";
import { v4 as uuid } from "uuid";

export default {
  key: "chatbot-new-event",
  name: "New Event",
  description: "Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)",
  version: "0.0.1",
  type: "source",
  props: {
    chatbot,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    name: {
      label: "Webhook Name",
      description: "The name of the webhook, this will be used to select in the ChatBot UI flow",
      type: "string",
      optional: true,
    },
  },
  methods: {
    async _respondWebHook(http, event) {
      http.respond({
        status: 200,
        body: event.query.challenge,
      });
    },
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const validationToken = uuid();

      const response = await this.chatbot.createWebhook({
        auth: {},
        headers: [],
        name: this.name ?? `Webhook ${validationToken}`,
        token: validationToken,
        url: this.http.endpoint,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.chatbot.deleteWebhook(webhookId);
    },
  },
  async run(event) {
    await this._respondWebHook(this.http, event);

    const {
      body,
      headers,
    } = event;

    this.$emit(body, {
      id: headers["x-request-id"],
      summary: `New event ${headers["x-request-id"]} received`,
      ts: new Date(),
    });
  },
};

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
ChatBot	`chatbot`	`app`	This component uses the ChatBot 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.
Webhook Name	`name`	`string`	The name of the webhook, this will be used to select in the ChatBot UI flow

Trigger Authentication#

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

To retrieve your API keys,

Navigate to your ChatBot account and sign in
Go to “Settings” > “Developers” > “API keys”

Note: The client access token should be used to invoke /query endpoint. For other API endpoints use the Developer access token

About ChatBot#

ChatBot is an all-in-one platform to create, deploy, and track chatbots across channels.

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.