https://github.com/coderrob/backstage-plugin-scaffolder-backend-module-webex
A Backstage.io backend scaffolding plugin that provides actions for sending messages via Webex Incoming Webhooks in scaffolder templates, enabling automated notifications and integrations within your Backstage workflows.
https://github.com/coderrob/backstage-plugin-scaffolder-backend-module-webex
backstage backstage-plugin scaffolder webex webex-incoming-webhooks
Last synced: 8 months ago
JSON representation
A Backstage.io backend scaffolding plugin that provides actions for sending messages via Webex Incoming Webhooks in scaffolder templates, enabling automated notifications and integrations within your Backstage workflows.
- Host: GitHub
- URL: https://github.com/coderrob/backstage-plugin-scaffolder-backend-module-webex
- Owner: Coderrob
- Created: 2024-08-10T04:02:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-17T07:45:28.000Z (9 months ago)
- Last Synced: 2025-02-17T08:32:11.163Z (9 months ago)
- Topics: backstage, backstage-plugin, scaffolder, webex, webex-incoming-webhooks
- Language: TypeScript
- Homepage: https://coderrob.com/
- Size: 944 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# @coderrob/backstage-plugin-scaffolder-backend-module-webex
The Webex scaffolding module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend). This Backstage.io module contains actions for sending messages using Webex Incoming Webhooks.
## Prerequisites
- [Node.js](https://nodejs.org/en/download) must be installed in the environment.
- You must have a [Webex Incoming Webhook](https://apphub.webex.com/applications/incoming-webhooks-cisco-systems-38054-23307-75252) 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:
```shell
yarn add --cwd packages/backend @coderrob/backstage-plugin-scaffolder-backend-module-webex
```
1. **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](https://backstage.io/docs/features/software-templates/writing-custom-actions/#registering-custom-actions) as follows:
```typescript
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.
1. **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:
```yaml
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/"
- "https://webexapis.com/v1/webhooks/incoming/" # optional ability to message multiple spaces
```
1. **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.