Last active
December 28, 2024 14:21
-
-
Save hankchanocd/acff5f702327051db9649956d39e4bbd to your computer and use it in GitHub Desktop.
Netlify Function Sends Slack Notifications
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /* | |
| Since late 2020, Netlify has put up a pay wall on its built-in Slack notifications for CI/CD. | |
| This gist shows you a workaround using the still-free Netlify's deploy webhook that triggers a Netlify Function calling Slack Incoming Webhook. | |
| Steps: | |
| 1. Deploy this Netlify Function | |
| 2. Have the corresponding link pasted into Netlify's deploy webhook, i.e. https://example.com/.netlify/functions/<your-function> | |
| 3. In next deploy, Netlify will trigger the deploy webhook, which in turn calls your Slack Incoming Webhook | |
| */ | |
| const fetch = require('node-fetch'); // Don't forget to hit `npm i node-fetch` | |
| const WebHookURL = process.env.SLACK_WEBHOOK; // Store the Slack Incoming Webhook in Netlify's environment | |
| const messageBody = { | |
| "username": "Deploy to Netlify", | |
| "text": "Successful deploy of <your-website>", | |
| "attachments": [ | |
| { | |
| "color": "#2eb886", // Green | |
| "fields": [ // Green bar | |
| { | |
| "title": "Status", | |
| "value": "Success", | |
| "short": true | |
| } | |
| ], | |
| "actions": [ // Slack supports many kind of different types, we'll use buttons here | |
| { | |
| "type": "button", | |
| "text": "Website", | |
| "style": "primary", // you can have buttons styled either primary(green) or danger(red) | |
| "url": "<Your Website>" | |
| }, | |
| { | |
| "type": "button", | |
| "text": "Deploy Status", // text on the button | |
| "url": "<Your Netlify's Build Status Link>" // url the button will take the user if clicked | |
| }, | |
| { | |
| "type": "button", | |
| "text": "Github Repo", | |
| "url": "<Your Github Link>" | |
| } | |
| ] | |
| } | |
| ] | |
| }; | |
| // main | |
| module.exports.handler = async function() { | |
| if (!WebHookURL) { | |
| console.error('Please fill in your Webhook URL'); | |
| return { | |
| statusCode: 400, | |
| body: JSON.stringify({ | |
| msg: "Couldn't find SLACK_WEBHOOK" | |
| }) | |
| }; | |
| } | |
| console.log('Sending slack message'); | |
| const options = { | |
| method: 'POST', | |
| headers: { | |
| 'Content-Type': 'application/json' | |
| }, | |
| body: JSON.stringify(messageBody) | |
| }; | |
| const response = await fetch(WebHookURL, options); | |
| console.log(response) | |
| return { | |
| statusCode: 200, | |
| body: JSON.stringify({ | |
| msg: "Success" | |
| }) | |
| }; | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment