This content originally appeared on DEV Community and was authored by Mark Orina
Introduction:
Amplify notifications allow you to receive real-time updates about your Amplify application deployments. This guide demonstrates how to set up Slack notifications to receive messages directly in a designated Slack channel whenever your Amplify builds are successful (or unsuccessful, depending on your preference).
Amplify notifications --> SNS --> Slack Channel
Benefits of Slack Notifications:
- Stay informed: Get notified about build statuses without manually checking the console.
- Improve team communication: Keep your team updated on deployment progress.
- Faster issue identification: Quickly identify potential issues with failed builds.
Set up Slack
We need a webhook from Slack that AWS SNS will use to communicate with Slack
1.Create a Slack Channel:
*Designate a specific channel to receive Amplify build notifications (e.g.,#test24).
2.Build a Workflow:
- Go to your Slack workspace and navigate to Tools & Settings > Workflow Builder.
- Click New Workflow and choose Build a workflow.
- Name your workflow appropriately (e.g., amplify-build-notifications).
- Under "Choose a trigger", select From a webhook. *Click on the untitled and name your workflow appropriately. I will call mine: #test-24
*Just below the start of the workflow click on Choose Event and then click on From a webHook.
- Set Up Variables: You will need to add a data variable we will use with AWS SNS.
- Click on Set Up Variables.
- Create a variable named
SubscribeURLwith a " Text " data type. This will store the webhook URL from Slack. Data type: Text (as the payload from SNS will be text)
Click done and then continue.
4.Get the Webhook URL:
- Click on Starts with a webhook again.
- Scroll down and locate the Web request URL. Copy this link.
5.Send Message to Channel:
-
Click Add a step.
- Search for "Send to channel" and choose the desired channel (e.g., #test-24).
- Search for "Send to channel" and choose the desired channel (e.g., #test-24).
*Then on Add a message area click on Insert Variable at the bottom right and choose: 'SubscribeURL'.
*Make sure to add a word before the variable like Here.
Click save.
We are all set. Click on finish up and publish.
Configure Amplify Notifications:
Let us go to our AWS console especially where you have set up your Amplify app.
6.Add Email (Temporary Step):
- In the AWS console, navigate to your Amplify app.
- Go to App > Hosting > Build notifications.
Click on the app click on hosting and go to Build notifications.
- Follow the instructions to add an email address (Note: This step is temporary and helps create an SNS topic).
https://docs.aws.amazon.com/amplify/latest/userguide/notifications.html
- After adding the email, note down the SNS topic ARN. Follow these steps to add an email to get email notifications.
What this does is it creates an SNS topic and subscribes the email to it.
Take note of the arn on the email as you subscribed.
- Subscribe Webhook to SNS:
Let us go to AWS SNS to find the new Topic created.
Go to the AWS SNS service.
-
Scroll down to the Subscriptions area where you will see the email you used to subscribe to earlier.
- Locate the SNS topic created in step 1 (refer to the noted ARN).
We will now add another subscription by clicking on Create Subscription.
Click Create subscription.
Choose HTTPS as the protocol.
Copy the webhook we created from Slack earlier in the blog.Paste the copied Webhook URL from Slack into the Endpoint field.
- Click Create subscription.
- You'll see a pending confirmation status.
Confirm Subscription in Slack:
In your Slack channel, you'll receive a message with a subscription confirmation URL.
Copy the URL.
Go back to your SNS topic go to the subscription that is pending and click on confirm subscription.
- Go back to the SNS topic subscription in AWS and click the confirmation link.
- Paste the copied URL from Slack and click Confirm subscription.
Testing and Verification:
*Go back to the workflow and update another variable.
Click on the edit button of Start with a webhook.
*Add a new variable called Message and save.
*Click on Send a message to the channel and add the new variable.
*To test and see if it works redeploy your amplify application.
By following these steps, you'll have a seamless setup for receiving Amplify build notifications directly in your Slack channel, keeping your team informed about deployment progress.
This content originally appeared on DEV Community and was authored by Mark Orina
Mark Orina | Sciencx (2024-08-19T15:42:58+00:00) Enable Amplify Builds’ Notifications for Directly to a Slack Channel. Retrieved from https://www.scien.cx/2024/08/19/enable-amplify-builds-notifications-for-directly-to-a-slack-channel/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.