Integrating CodePipeline webhooks with Slack notifications

Question

Pulumi · Accepted Answer

Integrating AWS CodePipeline with Slack notifications allows developers to receive updates about their CI/CD processes directly within their Slack channels. This interaction can increase visibility into the deployment process, expedite feedback loops, and enhance collaboration.

To accomplish this, we'll leverage two main resources:

aws.codepipeline.Webhook: This resource is used to create a webhook that will trigger your pipeline as changes happen in the source repository. A CodePipeline webhook can filter events, meaning you'll only get the notifications you care about.
aws-native.codestarnotifications.NotificationRule: This AWS native resource connects CodePipeline with various targets, including AWS Chatbot, to send notifications to Slack. However, it seems Pulumi doesn't have direct support for AWS Chatbot, which would be needed to connect AWS notifications with Slack channels. As a workaround, you can manually configure AWS Chatbot to work with Slack, and then use the NotificationRule to send pipeline notifications to the Chatbot, which can post them to Slack.

In the following program, I'll assume the AWS Chatbot has already been set up to communicate with your Slack workspace. Please replace the placeholders with the actual values from your setup. Also, ensure you have Pulumi set up correctly with the appropriate AWS credentials configured.

Now, let's see how the Pulumi TypeScript program looks:

import * as aws from '@pulumi/aws';
import * as awsNative from '@pulumi/aws-native';

// Assuming you have an existing CodePipeline resource named `myPipeline`
const myPipeline = /* reference to your existing pipeline */

// Create a webhook for CodePipeline to trigger on source changes
const pipelineWebhook = new aws.codepipeline.Webhook("myPipelineWebhook", {
    authentication: "GITHUB_HMAC",
    filters: [{
        jsonPath: "$.ref",
        matchEquals: "refs/heads/{Branch}",
    }],
    targetAction: "Source",
    targetPipeline: myPipeline.name,
    authenticationConfiguration: {
        secretToken: "<github-webhook-secret>",
    },
});

// Creation of a notification rule for the pipeline
const slackNotificationRule = new awsNative.codestarnotifications.NotificationRule("slackNotificationRule", {
    detailType: "FULL", // Choose between BASIC, FULL
    eventTypeIds: [
        "codepipeline-pipeline-pipeline-execution-started",
        "codepipeline-pipeline-pipeline-execution-succeeded",
        "codepipeline-pipeline-pipeline-execution-failed",
        // ... more event type IDs as needed
    ],
    name: "notifySlack",
    resource: myPipeline.arn,
    targets: [
        {
            targetType: "AWSChatbotSlack", // Assuming AWS Chatbot is set up for Slack
            targetAddress: "<chatbot-slack-configuration-arn>", // ARN for the Chatbot config
        }
    ],
});

// Export the webhook URL so you can configure GitHub or your source control to call it
export const webhookUrl = pipelineWebhook.url;

Replace <github-webhook-secret> with the secret token generated by GitHub when setting up your webhook. The targetPipeline and targetAction will depend on the specifics of your AWS CodePipeline setup.

Replace <chatbot-slack-configuration-arn> with the ARN of the AWS Chatbot Slack configuration. This ARN is provided by AWS when you set up a Chatbot client with Slack integration.

The eventTypeIds property on the notification rule allows you to specify which events you want to receive notifications for. In this example, I've shown how to add notifications for when a pipeline execution has started, succeeded, or failed, but there are many other event types you can subscribe to based on your requirements.

The webhookUrl output can be used to set up the webhook in your source provider (GitHub in this example) to trigger the pipeline.

Please note that this code assumes the existence of a pipeline in AWS CodePipeline. If you need to create a pipeline within the program, you would need additional code to define the stages and actions of the pipeline.