@pipedream/statuspage 0.0.3 → 0.0.4

package/README.md

@@ -1,19 +1,11 @@
 # Overview
 
-Using the Statuspage API, you can develop powerful and secure software
-solutions that enable communication with end-users. You can use it to build:
+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.
 
-- End-user facing applications that can be integrated with your other systems,
-  allowing customers to access your support team and get status updates.
-- Internal applications to manage customer accounts and payments, keeping track
-  of customer satisfaction and service levels.
-- Automated incident response systems that can be triggered to send
-  notifications and provide updates in the event of an incident.
-- A real-time dashboard to monitor performance and reliability metrics,
-  aggregate and analyze customer support data, and keep track of compliance.
-- Self-service applications to put the power in the hands of your customers and
-  give them the information they need quickly and easily.
-- Custom integrations to drive effective communication and collaboration with
-  other tools and systems.
-- Automation tools that can get updates from your Statuspage to other systems,
-  allowing for streamlined and consistent communication.
+# Example Use Cases
+
+- **Incident Response Automation**: Trigger a workflow on Pipedream when a monitoring app detects an outage, automatically creating an incident on Statuspage and sending notifications via communication platforms like Slack or email.
+
+- **Scheduled Maintenance Reminder**: Set up a recurring Pipedream workflow that posts upcoming maintenance events to Statuspage and simultaneously reminds your team via a tool like Google Calendar, ensuring that all parties are aware and prepared.
+
+- **Subscriber Update Sync**: Whenever a Statuspage incident is updated or resolved, a workflow can sync this status to a customer relationship management platform like Salesforce or Zendesk, keeping customer-facing teams informed and improving response times.

package/actions/create-incident/create-incident.mjs

@@ -2,7 +2,12 @@ import statuspage from "../../statuspage.app.mjs";
 
 export default {
   name: "Create Incident",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   key: "statuspage-create-incident",
   description: "Creates an incident. [See docs here](https://developer.statuspage.io/#create-an-incident)",
   type: "action",

package/actions/update-incident/update-incident.mjs

@@ -2,9 +2,14 @@ import statuspage from "../../statuspage.app.mjs";
 
 export default {
   name: "Update Incident",
-  version: "0.0.3",
+  version: "0.0.5",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   key: "statuspage-update-incident",
-  description: "Updates an existing incident. [See docs here](https://developer.statuspage.io/#update-an-incident)",
+  description: "Updates an existing incident. [See the documentation](https://developer.statuspage.io/#update-an-incident)",
   type: "action",
   props: {
     statuspage,
@@ -34,6 +39,19 @@ export default {
       description: "The body of the update",
       type: "string",
     },
+    componentIds: {
+      label: "Component IDs",
+      description: "The IDs of the components affected by this incident update (e.g., `[\"ftgks51sfs2d\", \"bb5w0kc1234x\"]`). Leave empty to keep the existing affected components unchanged.",
+      type: "string[]",
+      propDefinition: [
+        statuspage,
+        "componentId",
+        (c) => ({
+          pageId: c.pageId,
+        }),
+      ],
+      optional: true,
+    },
   },
   async run({ $ }) {
     const response = await this.statuspage.updateIncident({
@@ -44,6 +62,9 @@ export default {
         incident: {
           status: this.status,
           body: this.body,
+          ...(this.componentIds?.length && {
+            component_ids: this.componentIds,
+          }),
         },
       },
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/statuspage",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Pipedream Statuspage Components",
   "main": "statuspage.app.mjs",
   "keywords": [
@@ -14,6 +14,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.2.1"
+    "@pipedream/platform": "^1.6.8"
   }
 }