@coderrob/backstage-plugin-scaffolder-backend-module-webex

The Webex scaffolding module for @backstage/plugin-scaffolder-backend. This Backstage.io module contains actions for sending messages using Webex Incoming Webhooks.

Prerequisites

• Node.js must be installed in the environment.
• You must have a Webex Incoming Webhook URL available to send messages.

Getting Started

To add the Webex scaffolding module to your Backstage project, follow these steps:

1. Install the module:

   In the root directory of your Backstage project, run the following command:

   yarn add --cwd packages/backend @coderrob/backstage-plugin-scaffolder-backend-module-webex

2. Register the custom action:

   After installing the module, you'll need to register the Webex scaffolding module in your Scaffolder backend.

   Open your packages/backend/src/plugins/scaffolder.ts file and register the custom action as follows:

   const backend = createBackend();
   backend.add(import('@backstage/plugin-scaffolder-backend/alpha'));
   backend.add(import('@coderrob/backstage-plugin-scaffolder-backend-module-webex'));

   This code snippet registers the createSendWebhooksMessageAction with the Scaffolder backend using the latest Backstage.io backend framework.

3. Using the action in a scaffolder template:

   Once the action is registered, you can use it in your scaffolder templates to send messages via Webex Incoming Webhooks.

   Here's an example template:

   spec:
     . . .
     steps:
       - id: send-webex-message
         name: Send Webex Message
         action: webex:webhooks:sendMessage
         input:
           format: "markdown"
           message: "# This Could Be Us"
           webhooks:
             - "https://webexapis.com/v1/webhooks/incoming/<SPACE_ID>"
             - "https://webexapis.com/v1/webhooks/incoming/<SPACE_ID>" # optional ability to message multiple spaces

4. Deploy and test:

   With everything configured, deploy your Backstage instance and test the Webex Incoming Webhooks action by running a template that includes the webex:webhooks:sendMessage step.

   If everything is set up correctly, the specified Webex channels should receive the messages as defined in your template.