This is a Sample Java Servlet to demonstrate how to create and use App Users through the Box Java SDK, and how

deploy the App on AWS and use the new Webhooks V2 API to send messages to an Amazon Lamba Service.

We have not included any security features in the application and strictly recommend NOT to use any part of the application for production usage. Do not store any sensitive data in the application.

We recommend creating a test developer enterprise, a test application within the enterprise, and integrating the sample Box Application's API key with this Sample Application. Once the testing is done, we recommend stopping the server, deleting the app from the Box developer console, ending all Box sessions tied to the sample application, and deleting the App Users created in the test enterprise from the admin console.

The public and private key pairs used along with this sample application should not be reused with applications handling production data and should be discarded once testing completes

Usage of this sample application with production enterprises or production data is highly undesirable.

Box is not responsible for any security incidents that may arise due to the unsafe usage of this sample application.

You will need to have Amazon Web Services account created to use this example. To create new account visit here.

In order to create the simplest possible code to demonstrate how to use Box Webhooks together with AWS this sample COMPLETELY IGNORES App User Authentication.
It asks for passwords but ignores them.

You will need to create an application that supports App Users. Steps are described here.

During the process you have created private key. This key is needed by the Box SDK to authenticate yourself and your App Users.

As for Amazon Web Services we are going to use the following services:

• DynamoDB
  • non-relational database for storing mapping between user files and notification emails
  • more information can be found here
• Simple Notification Service (SNS)
  • service used to send notification emails
  • more information can be found here
• Lambda
  • execution part of the application
  • manages webhook notification registration in storage as well as triggering email notification
  • more information can be found here
• API Gateway
  • web resources for registering webhook notifications and Box Webhooks triggers
  • more information can be found here
• Elastic Beanstalk
  • easy-to-use deployment of our example web application on Amazon
  • more information can be found here
• CloudFormation
  • gives an easy way to create and manage a collection of related AWS resources
  • service used to prepare our Sample AWS Environment

In order for the sample application to work with your Box Application you have created in previous steps, you will need to fill the following values. Rename gradle.properties.template file in sample root to gradle.properties and replace placeholders with values for your application and enterprise account.

{boxEnterpriseId}         enterprise ID of your Box account
{boxClientId}             client ID of the Box Application
{boxClientSecret}         client secret of the Box Application
{boxPublicKeyId}          ID of your public key in the Box Application
{boxPrivateKeyPassword}   password for your private key
{boxPrivateKeyFile}       absolute path of your private key file

You are now ready to build your packages.

In order to get packages we need to configure AWS environment use Gradle build task in root directory of the sample application:

For Mac/Linux:

../gradlew clean build

For Windows:

../gradlew.bat clean build

The build process will build WAR file for our Web Application to be deployed on Elastic Beanstalk, ZIP file for Lambda function and also CloudFormation configuration file. Files can be found in build/distributions/aws-s3 directory.

We are now ready to setup AWS environment. We will do so by using CloudFormation. To make our packages accessible to CloudFormation, we will upload them to S3 bucket.

1. Go to S3 Console and Create New Bucket
2. Choose name for your bucket (e.g. box-webhook-aws-config), region and click on Create
3. In your bucket, use Upload action and pick package files of the sample project to upload into bucket - box-webhook-aws-sns.zip and box-webhook-aws-webapp.war from build/distributions/aws-s3
4. Wait until the files are upload before proceeding to next step

Note: In order for CloudFormation to be able to create resources necessary, make sure you have administrator access rights.

1. Go to CloudFormation Console and Create New Stack
2. Use Choose File in Choose a template section and select build/distributions/aws-s3/cloudformation.json
3. On the Next page (Specify Details) fill out Stack name (e.g. box-webhook-aws-stack) and S3 Bucket name, where you uploaded the packages
4. On the Next page (Options) just click on Next
5. On the Review page you have to accept Capabilities at the bottom of the page: 'I acknowledge that this template might cause AWS CloudFormation to create IAM resources.'
6. Click on Create and give it some time to prepare the environment (you can watch progress in 'Events' tab)
7. After everything is finished switch to 'Outputs' tab of the stack, where 'URL of the Web Application' can be found

After the setup above everything should be ready to test the example.

1. Go to your 'URL of the Web Application', which will start your Sample Web Application
2. Login as your AppUser (or create a new one)
3. Open any of your files, which supports Preview (or upload a new one)
4. Now you can fill out Email Address for notification and confirm it by OK
5. If everything is set up properly you should get Subscription Confirmation Email from AWS Notifications, which you must Confirm (using the link in email). Note: If you don't see this confirmation email, check you spam folder.
6. Preview the file to test the functionality. You should receive an email describing the file previewed and the user who previewed it.