{"id":21578088,"url":"https://github.com/maasglobal/serverless-plugin-notification","last_synced_at":"2025-04-10T17:29:53.241Z","repository":{"id":79694551,"uuid":"96182405","full_name":"maasglobal/serverless-plugin-notification","owner":"maasglobal","description":"Setup a notification system that reports all Serverless framework action to multiple platforms","archived":false,"fork":false,"pushed_at":"2019-09-09T11:28:41.000Z","size":12,"stargazers_count":7,"open_issues_count":3,"forks_count":9,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-08T17:09:36.756Z","etag":null,"topics":["serverless","slack","webhook"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/maasglobal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-07-04T06:21:16.000Z","updated_at":"2020-08-18T09:07:47.000Z","dependencies_parsed_at":"2023-05-02T11:48:27.448Z","dependency_job_id":null,"html_url":"https://github.com/maasglobal/serverless-plugin-notification","commit_stats":{"total_commits":16,"total_committers":4,"mean_commits":4.0,"dds":0.25,"last_synced_commit":"8d79c2594f1f57eee9918c4809c3c91602a3544d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maasglobal%2Fserverless-plugin-notification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maasglobal%2Fserverless-plugin-notification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maasglobal%2Fserverless-plugin-notification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maasglobal%2Fserverless-plugin-notification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maasglobal","download_url":"https://codeload.github.com/maasglobal/serverless-plugin-notification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248261989,"owners_count":21074229,"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":["serverless","slack","webhook"],"created_at":"2024-11-24T13:09:35.482Z","updated_at":"2025-04-10T17:29:53.214Z","avatar_url":"https://github.com/maasglobal.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serverless Plugin Notification\n\n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)\n[![npm version](https://badge.fury.io/js/serverless-plugin-notification.svg)](https://badge.fury.io/js/serverless-plugin-notification)\n\n## Requirement\n1. Serverless 1.x\n2. Project setup for AWS provider\n\n## Plugin installation\n1. Open a terminal to your Serverless project\n2. `npm install --save-dev serverless-plugin-notification`\n3. Add `serverless-plugin-notification` in your `serverless.yml` file (see [Serverless docs](https://serverless.com/framework/docs/providers/aws/guide/plugins/#installing-plugins))\n4. Follow platform specific installation\n  - [Slack](#slack)\n  - [Webhook](#webhook)\n\n## Supported platforms\n\n### Slack\n\n#### Feature\n1. Notify service deployment to predefined Slack channel with custom username. Supporting states\n  - Deployment started\n  - Deployment succeeded\n  - Deployment failed (TODO)\n2. Predefined message format - General info in post, function and endpoint listing in thread reply\n3. Support Slack thread\n4. Support automatically retrieving deployer name\n5. EMOJIs !\n\n#### Platform installation\n\nIn your `serverless.yml` fill the following configuration\n```yaml\ncustom:\n  notification:\n    deployer: /* Default deployer name, if not automatically retrieve from local variable, if not default to 'Unnamed deployer' */\n    slack:\n      token: /* Your slack token here */ - Follow https://api.slack.com/bot-users to get bot access token\n      channel:  /* Your channel name here */ e.g '#serverless' NOTE: Using direct message '@person' will have 'channel_not_found' error at `Deployment succeeded` and `Deployment failed`\n      username: /* (Optional) Username that will be used to post the message */\n```\n\n### Webhook\n\n#### Feature\n1. Notify service deployment through http webhook POST using configurable url and headers. Supporting states:\n  - Deployment started\n  - Deployment succeeded\n  - Deployment failed (TODO)\n\n#### Missing pieces\n1. `Content-Type` currently support only `application/json`\n2. Does not support CORs\n\n#### Plattform installation\nIn your `serverless.yml` fill the following configuration\n```yaml\ncustom:\n  notification:\n    webhook:\n      url: /* Your webhook url here */\n      headers: /* Your headers here - Must be in object format */\n        Content-Type: application/json\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaasglobal%2Fserverless-plugin-notification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaasglobal%2Fserverless-plugin-notification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaasglobal%2Fserverless-plugin-notification/lists"}