Display banner/modal on a Miro board using DynamoDB

Using the Miro Web SDK, you can seamlessly display a custom banner/modal (Figure 1) into your Miro boardβ€”a powerful way to strategically showcase tailored content or compelling calls to action, providing an enhanced and personalized user experience.

πŸ“˜

Note

We use the terms banner and modal interchangeably in this guide. In the Miro Developer Platform, a modal is a visual screen that can display custom information. A modal might also be called as a banner in general terms. We use the terms banner/modal to make it easier for everyone to follow the context.

Figure 1. Example of a banner/modal

`

  • Miro Web SDK
  • AWS S3: Host your HTML files and serve them as regular web pages so they can load within Miro.
  • AWS DynamoDB: Database for your Miro app to track which users have already accepted the modal so that the modal does not keep appearing for those users.

There are four main action items for displaying a banner on a Miro board. We will walk through the steps in each of these main action items in detail.

  1. Create AWS resources (S3 Bucket, DynamoDB, API Gateway, and Lambda function).
  2. Upload/host the app.html, modal.html and variables.js files on the AWS S3 bucket.
  3. Create the application in Miro that will run the hosted app.html file.
  4. Install the banner/modal app in all Miro teams where you want to display the modal/banner.

🚧

Disclaimer

The information in this guide is provided as an example and guidance only. Any production setup is at your sole discretion and responsibility and is to be throughly tested and validated on your side by the responsible teams to ensure it works as desired and intended.

In addition, this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Step 1: create AWS resources

πŸ“˜

Hint

The steps explained within this section use the AWS Serverless Application Model (AWS SAM). You must install AWS SAM CLI and set up your AWS credentials so you can programmatically create AWS resources using AWS SAM.

In this step, we will create the following AWS resources:

  • S3 bucket: You can host the frontend web assets for your banner app (app.html, modal.html, and variables.js files) in this publicly accessible S3 bucket.
  • DynamoDB simple table: The database to store the user's acceptance of the company's terms of usage policy (content on the banner) and to query users who have already accepted the terms of usage.
  • API gateway: Allows you to call a Lambda function to read and write data on the DynamoDB table from the app.html and modal.html files.
  • Lambda function: Takes care of writing and reading data from the DynamoDB table.
  1. If you already installed and set up AWS SAM CLI, skip this step and proceed to step 2.
    Install and set up AWS SAM CLI by following the steps explained in the AWS documentation: Installing the AWS SAM CLI.

    πŸ“˜

    Tip

    Ensure to review the prerequisites before installing AWS SAM CLI.

  2. After you install and set up AWS SAM CLI with your AWS credentials, go to this GitHub repository and install the prerequisites listed in the README.md file.

  3. Look at this GitHub repository and review the settings of the AWS resources that will be created automatically for you via the AWS SAM CLI. The main SAM template is within the file template.yaml.

  1. In the CLI window, navigate to your dedicated local folder for this project and run the following command:

    git clone https://github.com/miroapp/app-examples.git
    cd app-examples/examples/terms-modal-banner-dynamodb/
    sam deploy --guided --capabilities CAPABILITY_NAMED_IAM
    

    🚧

    Important

    The API endpoint and the S3 bucket created in this guide have CORS settings enabled to allow access only from the origin of the S3 bucket itself but it has no extra authentication. The endpoints are available to any service on the internet where CORS restrictions don't apply, such as server-side services. If you want to add authentication, please review the example shown in the section titled Adding authentication to the upload process of the Uploading to Amazon S3 directly from a web or mobile application AWS article.

  2. Enter the following values for each of the prompts:

    • Stack name: miro-terms-banner
    • AWS region: add your desired region or hit Enter to accept the default
    • Confirm changes before deploy [Y/N]: accept default
    • Allow SAM CLI IAM role creation [Y/N]: Y
    • Disable rollback [y/N]: N
    • Save arguments to configuration file [Y/N]: accept default
    • SAM configuration file [samconfig.toml]: accept default
    • SAM configuration environment [default]: accept default
      After providing the inputs for these prompts, the AWS resources will be automatically created for you. Please wait until the process is complete.
  1. When the process is complete, you will see the Outputs with the relevant information as shown below (your values might be slightly different).

    ------------------------------------------------------------------------------------------------------------------
    Outputs
    ------------------------------------------------------------------------------------------------------------------
    Key           ApiBaseURL
    Description   Base URL of HTTP API endpoint to read and write on the MiroBannerTermsAcceptersTable database
    Value         https://18h77ynoy7.execute-api.eu-central-1.amazonaws.com
    
    Key           DynamoDBTableName
    Description   Name of the DynamoDB table that captures users who have accepted the terms banner in Miro
    Value         miro-terms-banner-accepters-database-0a67a265bc53
    
    Key           S3BucketName
    Description   Name of the S3 bucket where the web assets of the Miro app will be hosted
    Value         s3-miro-terms-banner-frontend-0a67a265bc53
    
    Key           S3BucketBaseUrl
    Description   Base URL of the S3 bucket where the web assets of the Miro app will be hosted
    Value         https://s3-miro-terms-banner-frontend-0a67a265bc53.s3.eu-central-1.amazonaws.com
    ------------------------------------------------------------------------------------------------------------------
    

🚧

Important

Keep your AWS SAM CLI window open. You will need the values from the Outputs in the next steps.

🚧

Troubleshooting

AWS SAM uses CloudFormation in the background to create your AWS resources programatically. If the deployment fails or if you closed the AWS SAM CLI window without noting the outputs, perform the following steps to clean up your AWS resources to ensure you can redeploy successfully:

  1. Empty S3 buckets.
  2. Delete S3 buckets.
  3. Delete Lambda function.
  4. Delete API gateway service.
  5. Delete the DynamoDB table.
  6. Delete the CloudFormation stack created by AWS SAM.
  7. In the CLI window, navigate to your dedicated local folder for this project and ensure you are in the
    app-examples/examples/terms-modal-banner-dynamodb/ directory, and then run the following command:
    sam deploy --guided --capabilities CAPABILITY_NAMED_IAM
  8. Proceed with step 5, entering values for each of the prompts.

Step 2: upload and host app files on AWS S3

  1. Navigate to the local folder where you downloaded the GitHub repository and locate the files app.html, modal.html and variables.js (downloaded in step 1.3).

  2. In your AWS account, go to your newly created S3 bucket (you can find the S3 bucket name in the Outputs of your SAM CLI), and then create a new folder named webassets.

  3. Upload the files app.html and modal.html to the webassets folder in your S3 bucket.
    Do not upload the file variables.js.

  4. After uploading the files into the webassets folder in your S3 bucket, copy the URLs provided of the modal.html and app.html files. Paste these URLs into a text editor of your choice. You will need these URLs in the next steps.

  5. Open your local variables.js file (downloaded in step 1.3) and replace the values of the variables as follows:

    • MODAL_URL: enter the S3 URL of the modal.html file (copied in step 2.4).

      var MODAL_URL = 'https://miro-terms-banner-021ba44a2fc7.s3.eu-central-1.amazonaws.com/webassets/modal.html';
      
    • API_ENDPOINT_BASE_URL: enter the value for ApiBaseURL visible in the Outputs of your AWS SAM CLI.

      var API_ENDPOINT_BASE_URL = 'https://18h77ynoy7.execute-api.eu-central-1.amazonaws.com';
      
    • SECONDS_TO_WAIT: leave the default value (3) or enter your desired value (enter value as a number not as a string). This is the interval in seconds the app will check if the current user has accepted the terms banner/modal. With the default value (3), the app will check every 3 seconds if the user has accepted the banner/modal until the it has been successfully accepted.

      var SECONDS_TO_WAIT = 3;
      
    • MODAL_WIDTH: leave the default value (590) or enter a value as required based on your own pop-up design and content (enter value as a number not as a string). This is the width of the banner/modal pop-up in pixels.

      var MODAL_WIDTH = 590;
      
    • MODAL_HEIGHT: leave the default value (300) or enter a value as required based on your own pop-up design and content (enter value as a number not as a string). This is the height of the banner/modal pop-up in pixels.

      var MODAL_HEIGHT = 300;
      
  6. Save the variables.js file locally.

  7. Upload your local variables.js file into the webassets S3 folder created in step 2.2.

  8. From the Outputs of your AWS SAM CLI (step 1.6), copy the value for S3BucketBaseUrl. You will need it for the next steps.

    πŸ“˜

    Hint

    In the next steps, from 2.9 to 2.14, we will be adding CORS restrictions to the API endpoints. These steps are optional but recommended to add a layer of protection to your API endpoints.

  9. In your AWS web console, go to Lambda, and then click the MiroBannerTermsReadFunction link (created in step 1.6).

  10. Scroll down to the code source of the Lambda function and update line 14. The response header Access-Control-Allow-Origin is currently set to a wildcard character value (*). Replace the wildcard character (*) with the S3 Bucket Base URL you copied on step 2.8. Ensure to keep the double quotes around the URL.

  11. To save your changes, click Deploy.

  12. In your AWS web console, go to Lambda, and then click the MiroBannerTermsWriteFunction link (created in step 1.6).

  13. Scroll down to the code source of the Lambda function and update line 17. The response header Access-Control-Allow-Origin is currently set to a wildcard character value (*). Replace the wildcard character (*) with the S3 Bucket Base URL you copied on step 2.8. Ensure to keep the double quotes around the URL.

  14. To save your changes, click Deploy.

🚧

Important

By setting the S3 bucket base URL as the only allowed origin in the response headers of both Lambda functions (Read and Write), you restrict the API endpoints so they can be called only from the origin of your S3 bucket (where your Miro app is hosted). However, this protection applies only to services where CORS restrictions apply, such as web browsers. Other services, such as backend apps, can still call the endpoints.

Step 3: create the banner/modal app in Miro

πŸ“˜

Note

To perform the steps within this section you must be a Company Admin in your Miro account, as you will be creating an application and installing it on individual Miro teams or across the entire account.

After creating the AWS assets and hosting the app.html, modal.html and variables.js files on the newly created S3 bucket, you will need to create your banner/modal pop-up application in Miro. This application will launch the banner/modal pop-up window for each board in the Miro teams where this application is installed.

  1. If you already have a Dev team in Miro, skip this step and proceed to step 2.
    Create a Dev Team in your Miro account by clicking the following link:
    https://miro.com/app/dashboard/?createDevTeam=1
    If you are unable to create a Dev Team because the Domain Control feature is enabled and set to "Full" in your Miro account, please let your dedicated CSM or Solutions Engineer at Miro know and they will arrange to create a Dev Team for you.

  2. Click the top-right corner avatar on your Miro dashboard page, and then click Settings.

  3. Switch the profile selector to your Dev Team, and then click Profile settings > Your apps > Create new app.

  4. Enter an app name, and then click Create app.

  5. Navigate to the App URL field, enter the full URL of the app.html file (provided by AWS in step 2.4), and then click Save.

  6. Scroll down to the Permissions section, click to select the identity:read check box as the banner/modal app requires this permission, and then click click Install app and get OAuth token.

  7. Select your Dev Team, and then click Install & authorize.
    This will install the app on the Dev Team only for you to review and test before releasing it to the rest of the teams.

  8. Create a new Miro Board within your Dev Team, and refresh the page. The banner/modal pop-up appears.
    You can proceed to update the look and feel of the banner (modal.html) as required. Any changes to the app.html or modal.html files will reflect in Miro as well so you can easily update the content without having to do any additional work on Miro side.

πŸ“˜

Hint

The logic that captures the Miro User ID of the user accepting the banner/modal and the logic that checks if the user has already accepted the banner/modal is set within the JavaScript of the app.html, modal.html and variables.js files. Once a user was recorded in the DynamoDB table (by accepting the banner/modal) you can find the user within the DynamoDB table created in step 1.6 (search for the Miro User ID). Users within the DynamoDB table will not see the modal anymore.

During your tests, if you need to allow your test-user to see the modal again (after having accepted the modal), simply locate the Miro User ID of your test-user within the DynamoDB table and delete that entry from the database.

Step 4: install the banner app in your Miro teams

Once you have finalized all your changes to the banner/modal pop-up and you are ready to deploy it to other teams, proceed as follows:

  1. Go to your Dev Team profile, and then go to Profile settings > Your apps.

  2. Locate your banner/modal pop-up app in the list of apps, and then click it.

  3. Copy the Client ID of your app.

  4. Switch from the Dev Team to the main profile of your organisation.

  5. Click Apps and paste the Client ID of your app into the Search for an app field.

    You will notice that the name of your app appears directly below the input field as soon as you paste the app Client ID.

  6. Click on the name of your app that appears below the input field, and then click the Add button.

  7. A page appears asking you to select in which teams you would like to install the app. You have the option to install the app in all teams (at once) or in individual teams. For this guide we will install the app in all teams, but you can select specific teams, if required.

    πŸ“˜

    Hint

    If you select all teams when installing an app in Miro, any new teams you create later on will inherit the app automatically.

  8. After making your selection, click Next step.

  9. Activate the Allow for all teams check box, and then click the Install & allow button.

You will receive a message confirming the app has been installed in the selected teams.

The banner/modal pop-up app will check if the user opening a Miro Board has accepted the banner/modal terms every time a board opens on the teams where the app was installed. If the user has not accepted the terms, the banner/modal pop-up appears and will continue to appear until the user accepts the terms.