HollaEx®
⚙️ DashboardStart →
  • HollaEx® — The Crypto Exchange Solution
  • ☁️Cloud Operators
    • Launching the Exchange
    • Setting Domain for Cloud Exchanges
    • Easy SMTP for Cloud Exchanges
    • SEO Settings for Cloud Exchanges
      • SEO Advanced Settings
  • ⚙️Operating Your Exchange
    • Operator Control Panel
      • General
      • Users
      • User Profile
      • Assets
      • Markets
      • Stakes
      • Sessions
      • Plugins Apps
      • Trading Fees & Account Tiers
      • Roles
      • Chat
      • Billing
    • Customize Exchange
      • Browser Tools
        • Enter Edit Mode
        • Operator Controls (Visuals)
        • Console
      • Plugins
      • Forked Repo
    • Fiat Controls
      • Initial Setup
      • Setting Up Fiat On/ Off Ramp
      • Editing Deposit & Withdrawal Fees
      • Users Making Fiat Deposit
      • Users Trading With Fiat
      • User Making Fiat Withdrawal
    • Staking
    • OTC Broker
    • P2P
      • P2P Overview
      • P2P Setup
      • P2P Troubleshooting
      • P2P Vendor Flow
    • Smart Chain Trading
    • Assets & Trading Pairs
      • Add New Assets & Trading Pairs
      • Configure Pair Parameters
    • Set up the SMTP Email
      • Set up SMTP with AWS SES
      • Set up SMTP with Mailgun
      • Set up SMTP with SendGrid
      • Test the SMTP with Gmail
    • Enabling reCAPTCHA
    • Email Customization & Audit
    • DeFi Asset Staking Process
  • 🧩Plugins
    • HollaEx Plugins
      • Announcements
      • Bank
      • AWS SNS (Text Messages - SMS)
      • KYC
      • Automatic KYC
      • Messente
      • Advanced Referral
      • CoinMarketCap
      • Guardarian
    • Install Plugins
    • Developing Plugins
      • Development Walkthrough: Hello-Plugin
        • Initialization
        • Configuration
        • Scripting
        • Web View
        • The Final Product & Installation
      • Advanced
        • Initialization
        • Config
        • Server Script
        • Plugin Libraries
        • Web View
        • Final Plugin Product
        • Advanced Tutorial: Using the user meta field
        • Advanced Tutorial: Adding a new database table column
        • Advanced Tutorial: Creating a new database table
      • Simple Wallet Example
      • Web View Development
        • Overview
        • External dependencies
        • Getting started
        • Basic Tutorial: Hello Exchange Plugin web view
        • Advanced Tutorial: KYC Plugin web views
    • Bank Integration
      • Handling Deposits
      • Handling Withdrawals
  • 👷Developers
    • API Guide
      • API Example Scripts
    • Run Dev Mode
    • Build a New Front-end Interface
  • 🧰On-Premise Operators (Advanced Only)
    • On-Premise Exchange Setup
      • Getting Started — Requirements
      • Installation
      • Server Setup
      • Web Setup
      • Production
    • CLI How-Tos
      • Start Exchange
      • Stop Exchange
      • Upgrade Exchange
        • Build and Apply the Code Changes
      • Get Exchange Logs
      • Get a Backup and Restore
      • Exchange Migration
      • Command List
    • Run Exchange on Kubernetes
    • Troubleshooting Guide
  • 🚀Advanced
    • SEO Optimization
    • Nginx
    • Rate Limits
    • Database
      • Upgrade Database
    • Dependencies
    • Contents Delivery Network
      • Cloudflare CDN for HollaEx
      • CloudFront CDN for HollaEx
    • Load Balancer
      • AWS ELB
      • DigitalOcean LB
    • Customize Kubenretes Ingress
    • Exchange Keys
      • Exchange API Keys Troubleshoot
    • HollaEx on non-Linux
      • HollaEx on Windows
      • HollaEx on macOS
    • The Network Tool Library
      • Accessing the Network Tool Library
      • Functions
        • WebSocket
      • Simple Example: Creating a User and Wallet
      • Getting More Interesting: Orders with the Tools
        • Setup: Using the transferAsset function
        • Creating and Monitoring a Sell Order
        • Settling Fees
      • Private HollaEx Network
    • Docker Content Trust (DCT)
    • Revenue Sharing
  • 📦Releases
    • Release Notes
    • Side Notes
  • ➡️External Links
  • Blogs
  • Forum
  • Videos
  • Twitter X
  • Telegram
  • Interactive Demo
  • Discord Community
  • API Documentation
  • Tools Library Documentation
  • Node Library Documentation
  • Plugins Documentation
Powered by GitBook
On this page
  • Available To
  • What Is It?
  • Who Needs It?
  • How to Use It?
  • AWS Resources
  • Automated resource creation
  • Manual resource creation
  1. Plugins
  2. HollaEx Plugins

AWS SNS (Text Messages - SMS)

AWS SNS offers another way to notify users of activity on their accounts, sending quick texts for withdraws and deposits.

PreviousBankNextKYC

Last updated 6 months ago

Available To

Free for the following exchange plans:

  • Cloud Plans:

    • Crypto Pro

    • Enterprise

  • On-Premise Plans:

    • Boost

    • Voyager

What Is It?

The AWS SNS (Amazon Web Services Simple Notification Service) plugin simply sends a text message (assuming the user has supplied their phone number) notifying them of deposits and withdrawals.

Who Needs It?

Operators who want to give another method of communicating with their exchange's users, making users feel at ease that the system will alert them directly to their mobile in the case of any behavior.

How to Use It?

With this done the option of whether texts should be sent for both withdrawals and deposits is made. Save that and ready to go- just ensure to monitor the AWS IAM settings from time to time, to ensure that you have credits for sending messages.


For a user, this will look like the following for withdrawals and deposits:

AWS Resources

It is required to create a new IAM user to connect to the HollaEx AWS SNS plugin. The plugin will interact with AWS SNS to send text messages.

Please follow the guide below to create the resources.

Automated resource creation

You can apply a Cloudformation template to automate the IAM creation with a simple click and a few types. Please click the link below to proceed. The AWS Web console will pop up through the link. Please make sure to log in with your existing AWS account.

Once you click the link, you'll see a page to set multiple parameters. Here are a few important ones:

  • Stack name: The name of the Cloudformation stack. It is okay to leave it as default in most cases.

  • MyIAMUsername: The name of the new AWS IAM username that you are going to create. This will be used as a name for the IAM user with AWS S3 access. For example: sms-iam-user

It is not needed to set the "Permissions - optional" panel in most cases. You can simply skip.

It will take a few minutes for the system to create the resources.

Manual resource creation

You will need to make an IAM policy for an IAM user you are going to use for the SNS. You should create a new policy on the AWS IAM Console - Access Management - Policies page.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": "sns:Publish",
            "Resource": "*"
        }
    ]
}

Now, go to the AWS IAM Console - Access management - Users page to create a new user for KYC connection. The above policy can then be bound to the account.

Get the access key ID and secret access key once the account is created. Once this account is created, in the user field you will be provided the Access Key ID and Secret Access Key required.

Please refer to the section first, before proceeding.

After installing AWS SNS on the exchange, we will be given several fields to fill in. Filling these out requires with AWS SNS access. You'll need to create an IAM policy for the IAM user that you intend to use. This policy will ensure that the user has the appropriate permissions to access and use the SMS service.

The region should follow the of AWS.

Once it's all completed, you'll be able to check the output. You'll get everything necessary including the IAM Access Key and the Secret Key. Please save this information somewhere safe, and refer to the to configure the plugin. You are all good now!

🧩
region code
🔗 Cloudformation Template
AWS IAM key creation
AWS IAM credentials
docs