Set up a notification System with Contentstack Webhooks, AWS, Lambda, and AWS SNS

Notifications help systems to communicate with each other by notifying each other about any event happening that happens in real-time. In Contentstack, notifications can be triggered, via webhooks, when you perform actions such as content publishing, unpublishing, updation, and so on.

In this guide, we will set up a notification system by using Contentstack Webhooks, AWS SNS, and AWS Lambda function. This will help us send notifications to an endpoint of our choice when any event occurs in Contentstack. 

Overview of the process: We will set up a system that whenever someone updates an entry in Contentstack, a webhook will get triggered and connect with the AWS lambda function. This Lambda function then notifies AWS SNS about such an event. Then, you’ll receive an email notification, which contains a JSON payload of that specific entry. 

Prerequisites

To proceed with the procedure, the following is required:

• Basic knowledge of AWS SNS
• Working knowledge of AWS API Gateways
• Access to the AWS environment
• Contentstack account

Steps for Execution

Here are the steps to set up a notification system:

1. Create AWS SNS topic and subscription
2. Create AWS Lambda Function
3. Set up API Gateway
4. Deploy API
5. Set up Webhook in Contentstack
6. Try out the Setup

1. Create AWS SNS topic and subscription

   First, you’ll need to create an SNS topic to set up a communication channel. Here you can define via which channel (for example SQS, text message, email, etc) you want to send notifications.

   To create an AWS SNS topic, perform the following steps:

   1. Log in to your AWS Management Console and select Simple Notification Service from the Services dropdown menu.
   2. Next, go to the Topics section from the left navigation panel. This will open the Topics page.
   3. Click on the Create topic button.
   4. On the Create topic page, inside the Details section, provide the following details:
      1. Type: Choose the topic type as per your requirements. For this tutorial, we’ll select Standard as we are targeting to push notifications via emails.
      2. Name: Enter a name for your topic.
   5. Scroll down to the Access policy - optional section, click to expand it, and choose values for the following options:
      1. Choose method: Select Basic
      2. Define who can publish messages to the topic: Select Everybody to let Lambda function initiate the notification process.
      3. Define who can subscribe to this topic: By default, Only the topic owner option is selected. You can however choose another option if required.
         
   6. Click on the Create topic button.
   7. You’ll be directed to your topic’s screen. Make note of the ARN displayed in the Details section as you’ll need it in the next step.
   8. On your topic’s page, scroll down to the Subscriptions tab, and click the Create subscription button. This will open the Create subscription screen.
   9. In the Details section, select Email from the Protocols dropdown menu, and enter the email address where you want to send email notifications in the Endpoint field.
      
   10. Finally, click on the Create subscription button.
   The email, entered in the Endpoint field will receive an email to confirm the subscription. Before proceeding with the next steps in the guide, ensure to confirm the subscription first.
   

2. Create an AWS Lambda Function

   Let's now create an AWS Lambda function that sends the data (received from Contentstack via webhooks) to AWS SNS.

   1. From the Services dropdown list, select Lambda.
   2. On the Functions page, click on the Create function button.
   3. On the Create Function page, select Author from Scratch.
   4. In the Basic Information section below, provide a name for your function, choose any available version of Node.js, and click on the Create function button.
      You’ll be redirected to your lambda function’s page. Let’s proceed to configure this function.
      
   5. AWS Lambda offers an inline code editor where you can write your lambda code. Another option is to write the lambda code on your machine and then load it in the code editor.
      
      To write your own code, scroll down to the Code source section, located inside the Code tab, and open the index.js file, which is preloaded with a default basic code.
      
      
   6. Replace the default code in the index.js file with the code given below:
      console.log("Loading function");
      var AWS  = require("aws-sdk");
      const topicArn = "<arn_received_in_step_1>";
      const emailSubject = "Contentstack Webhook - Entry Updated";
      exports.handler = function(event, context){
          var eventText = JSON.stringify(event, null, 2);
          console.log("Received event");
          var sns = new AWS.SNS();
          var params = {
               Message: eventText,
               Subject: emailSubject,
               TopicArn: topicArn
               };
              sns.publish(params, context.done);
      };
      

      Provide the ARN, received in Step 1, for the topicArn variable.

   7. In the Runtime settings section, make sure the Handler is set to index.handler.

   Now that you have configured your lambda, let's move on and configure the AWS API Gateways.
   

3. Set up API Gateway

   For your Lambda to be accessible publicly through an HTTP POST, you need to configure the AWS API Gateway using your function as the backend for the API as shown below:

   1. Select API Gateway from the Services dropdown list and click on the Getting started or Create API button (depending on whether you have already an API configured or not).
   2. On the Choose an API type page, from the available options, scroll down to the REST API card and click Build.
   3. On the Create new API page, select New API, enter the name and description of your API, keep Endpoint Type as Regional, and click the Create API button.
      
      
   4. Click on Actions in the Resources column, and select Create Method.
      
      
   5. From the resultant dropdown, Select POST and click on the checkmark.
      
      
   6. Select Lambda Function as the integration type for this endpoint.
   7. Select the Lambda Region, and then type in the name of your Lambda Function.
      

      Note: The region into which your Lambda is deployed isn’t easily identifiable when you’re deploying your Lambda, so you might have to do a little hunting.

      
      
   8. Click on the Save button. You’ll get a popup window that asks you to confirm that this API will be granted permission to invoke your Lambda function.
   9. Click OK to grant the permission.

4. Deploy API

   To make your API ready to use, you need to deploy your API.

   1. From the Actions drop-down. select Deploy API.
      
      
      You’ll get the Deploy API popup window.
   2. Select [New Stage] in the Deployment stage option and enter prod (or anything you like to identify this stage) in the Stage name option.
   3. Click on the Deploy button.
   Your API is now deployed and you will get an Invoke URL, which you can use to invoke the APIs.
   

5. Set up Webhook in Contentstack

   To trigger the event on any update on the entry, you will have to set up a Webhook in Contentstack. To do this, log in to your Contentstack account and perform the following steps:

   1. Go to your stack, click the “Settings” icon on the left navigation panel and click on Webhook. You can also use the shortcut keys “alt + W” for Windows OS users, and “option + W” for Mac OS users to access webhooks.
      
   2. On the Webhook page, click on + New Webhook.
   3. Enter the name for your Webhook, for example, “AWS-Webhook Listener”
   4. In the URL to notify field, enter the Endpoint URL received in the Deploy API step.
   5. Scroll down to the When section for creating a trigger for the webhook as shown below:
      
      
   6. Select the Enable Webhook checkbox and Save your webhook settings.

6. Try out the Setup

   Go to any entry and update it. You’ll receive an email notification that contains details about the entry.

More Resources

You can refer to our guides on how you can use Contentstack Webhooks with AWS Lambda to automate several content management tasks.