SMS Service

Configuring the SMS Service allows you to send pipeline notifications and two-factor authentication (2FA) messages to mobile devices. This document describes how to configure SMS service for Buddy self-hosted.

Overview

You can use one of these two Amazon AWS services to send SMS:

SNS

✅ Supports Sender ID, i.e. name of the person sending the message.
❌ Can't send messages to U.S. numbers.

Pinpoint

✅ Can send messages to any country, including U.S. phone numbers.
❌ To use this service, you must be a verified AWS user and receive a permission.
❌ More expensive than SNS.

SNS configuration

To send SMS messages with Amazon SNS, you must create a user in Amazon IAM and configure a 3rd-party app in Buddy.

Configure the user in AWS

  1. Sign in to your AWS account.
  2. Go to the Services tab and choose IAM.
  3. Go to UsersAdd user.
  4. Enter a username and choose Programmatic access in the access type.
  5. Click Attach existing policies directly and select AmazonSNSFullAccess
  6. When ready, click Next: ReviewCreate user. Keep this tab open, you will need it in the next step!
Hint
You can also create your own Policy in which you have to allow sns:Publish.

Configure an SNS app in Buddy

  1. Sign in to Buddy as admin.
  2. Go to the Self-hosted Admin panel and switch to the 3rd-Party Apps tab.
  3. Click Amazon SNS/Pinpoint.
  4. Set the sending service to Amazon SNS and paste the user data from your Amazon IAM.
  5. Click Save changes and restart Buddy to apply the changes.

Image loading...Amazon SNS configurationAmazon SNS configuration

Pinpoint configuration

To send SMS messages with Amazon Pinpoint, you must create a user in Amazon IAM and configure a 3rd-party app in Buddy.

Create a Pinpoint project

Sign in to your AWS account and configure your Pinpoint service following these instructions.

Configure a user in AWS

  1. Sign in to your AWS account.
  2. Go to the Services tab and choose IAM.
  3. Go to UsersAdd user.
  4. Enter a username and choose Programmatic access in the access type.
  5. Create a new policy and select mobiletargeting:SendMessages
  6. When ready, click Next: ReviewCreate user. Keep this tab open, you will need it in the next step!

Configure a Pinpoint app in Buddy

  1. Sign in to Buddy as admin.
  2. Go to the Self-hosted Admin panel and switch to the 3rd-Party Apps tab.
  3. Click Amazon SNS/Pinpoint.
  4. Set the sending service to Amazon Pinpoint and paste the user data from your Amazon IAM.
  5. Click Save changes and restart Buddy to apply the changes.

Image loading...Amazon Pinpoint configurationAmazon Pinpoint configuration

Last update:
Sep 24, 2024