{"id":25898147,"url":"https://github.com/coderrob/backstage-plugin-scaffolder-backend-module-webex","last_synced_at":"2025-03-03T00:17:15.236Z","repository":{"id":255300926,"uuid":"840575548","full_name":"Coderrob/backstage-plugin-scaffolder-backend-module-webex","owner":"Coderrob","description":"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.","archived":false,"fork":false,"pushed_at":"2025-02-17T07:45:28.000Z","size":967,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T08:32:11.163Z","etag":null,"topics":["backstage","backstage-plugin","scaffolder","webex","webex-incoming-webhooks"],"latest_commit_sha":null,"homepage":"https://coderrob.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Coderrob.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-10T04:02:50.000Z","updated_at":"2025-02-17T07:42:24.000Z","dependencies_parsed_at":"2024-08-29T06:24:40.544Z","dependency_job_id":"8a78357b-0a12-447c-97b5-34cff569d967","html_url":"https://github.com/Coderrob/backstage-plugin-scaffolder-backend-module-webex","commit_stats":null,"previous_names":["coderrob/backstage-plugin-scaffolder-backend-module-webex"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fbackstage-plugin-scaffolder-backend-module-webex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fbackstage-plugin-scaffolder-backend-module-webex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fbackstage-plugin-scaffolder-backend-module-webex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fbackstage-plugin-scaffolder-backend-module-webex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Coderrob","download_url":"https://codeload.github.com/Coderrob/backstage-plugin-scaffolder-backend-module-webex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241587840,"owners_count":19986628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backstage","backstage-plugin","scaffolder","webex","webex-incoming-webhooks"],"created_at":"2025-03-03T00:17:14.535Z","updated_at":"2025-03-03T00:17:15.231Z","avatar_url":"https://github.com/Coderrob.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/coderrob"],"categories":[],"sub_categories":[],"readme":"# @coderrob/backstage-plugin-scaffolder-backend-module-webex\n\n\u003ca href=\"https://www.buymeacoffee.com/coderrob\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-white.png\" alt=\"Buy Me A Coffee\" style=\"height: 50px !important;width: 200px !important;\" \u003e\u003c/a\u003e\n\nThe 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.\n\n## Prerequisites\n\n- [Node.js](https://nodejs.org/en/download) must be installed in the environment.\n- You must have a [Webex Incoming Webhook](https://apphub.webex.com/applications/incoming-webhooks-cisco-systems-38054-23307-75252) URL available to send messages.\n\n## Getting Started\n\nTo add the Webex scaffolding module to your Backstage project, follow these steps:\n\n1. **Install the module:**\n\n   In the root directory of your Backstage project, run the following command:\n\n   ```shell\n   yarn add --cwd packages/backend @coderrob/backstage-plugin-scaffolder-backend-module-webex\n   ```\n\n1. **Register the custom action:**\n\n   After installing the module, you'll need to register the Webex scaffolding module in your Scaffolder backend.\n\n   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:\n\n   ```typescript\n   const backend = createBackend();\n   backend.add(import('@backstage/plugin-scaffolder-backend/alpha'));\n   backend.add(import('@coderrob/backstage-plugin-scaffolder-backend-module-webex'));\n   ```\n\n   This code snippet registers the `createSendWebhooksMessageAction` with the Scaffolder backend using the latest Backstage.io backend framework.\n\n1. **Using the action in a scaffolder template:**\n\n   Once the action is registered, you can use it in your scaffolder templates to send messages via Webex Incoming Webhooks.\n\n   Here's an example template:\n\n   ```yaml\n   spec:\n     . . .\n     steps:\n       - id: send-webex-message\n         name: Send Webex Message\n         action: webex:webhooks:sendMessage\n         input:\n           format: \"markdown\"\n           message: \"# This Could Be Us\"\n           webhooks:\n             - \"https://webexapis.com/v1/webhooks/incoming/\u003cSPACE_ID\u003e\"\n             - \"https://webexapis.com/v1/webhooks/incoming/\u003cSPACE_ID\u003e\" # optional ability to message multiple spaces\n   ```\n\n1. **Deploy and test:**\n\n   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.\n\n   If everything is set up correctly, the specified Webex channels should receive the messages as defined in your template.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderrob%2Fbackstage-plugin-scaffolder-backend-module-webex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderrob%2Fbackstage-plugin-scaffolder-backend-module-webex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderrob%2Fbackstage-plugin-scaffolder-backend-module-webex/lists"}