Authgear
Start BuildingHomePortalCommunity
  • Authgear Overview
  • Get Started
    • Start Building
    • 5-Minute Guide
    • Single-Page App
      • JavaScript (Web)
      • React
      • Angular
      • Vue
    • Native/Mobile App
      • iOS SDK
      • Android SDK
        • Android Kotlin coroutine support
        • Android OKHttp Interceptor Extension (Optional)
      • Flutter SDK
      • React Native SDK
      • Ionic SDK
      • Xamarin SDK
      • Using Authgear without SDK (Client side)
    • Regular Web App
      • Express
      • Next.js
      • Python Flask App
      • Java Spring Boot
      • ASP.NET Core MVC
      • Laravel
      • PHP
    • Backend/API Integration
      • Validate JWT in your application server
      • Forward Authentication to Authgear Resolver Endpoint
    • AI Coding tools
      • Cursor/Windsurf
  • How-To Guides
    • Authenticate
      • Add Passkeys Login
      • Add WhatsApp OTP Login
      • Add Email Magic Link Login
      • Add Biometric Login
      • Add Anonymous Users
      • Add authentication to any web page
      • Enable Two-Factor Authentication (2FA)
      • How to Use the OAuth 2.0 State Parameter
      • Reauthentication
      • How to Use Social/Enterprise Login Providers Without AuthUI
      • Passwordless Login for Apple App Store Review
      • Setup local development environment for Cookie-based authentication
      • Forgot/Reset Password settings
      • Phone number validation
      • Set Password Expiry
    • Single Sign-on
      • App2App Login
      • Pre-authenticated URLs
      • SSO between Mobile Apps / Websites
      • Force Authgear to Show Login Page
      • Single Sign-On with OIDC
      • Single Sign-On with SAML
        • Use Authgear as SAML Identity Provider for Salesforce
        • Use Authgear as SAML Identity Provider for Dropbox
        • SAML Attribute Mapping
    • Social Login / Enterprise Login Providers
      • Social Login Providers
        • Connect Apps to Apple
        • Connect Apps to Google
        • Connect Apps to Facebook
        • Connect Apps to GitHub
        • Connect Apps to LinkedIn
        • Connect Apps to WeChat
      • Enterprise Login Providers
        • Connect Apps to Azure Active Directory
        • Connect Apps to Microsoft AD FS
        • Connect Apps to Azure AD B2C
      • Force Social/Enterprise Login Providers to Show Login Screen
    • Built-in UI
      • Branding in Auth UI
      • User Settings
      • Privacy Policy & Terms of Service Links
      • Customer Support Link
      • Custom Text
    • Custom UI
      • Authentication Flow API
      • Implement Authentication Flow API using Express
      • Implement Authentication Flow API using PHP
      • Add Custom Login/Signup UI to Native Apps
      • Manually Link OAuth Provider using Account Management API
      • Implement a custom account recovery UI using Authentication Flow API
    • Integrate
      • Add custom fields to a JWT Access Token
      • User Analytics by Google Tag Manager
      • Track User Before and After Signup
      • Custom domain
      • Custom Email Provider
      • Custom SMS Provider
        • Twilio
        • Webhook/Custom Script
      • Integrate Authgear with Firebase
    • Monitor
      • Audit Log For Users Activities
      • Audit Log for Admin API and Portal
      • Analytics
    • User Management
      • Account Deletion
      • Import Users using User Import API
      • Export Users using the User Export API
      • Manage Users Roles and Groups
      • How to Handle Password While Creating Accounts for Users
    • User Profiles
      • What is User Profile
      • Access User Profiles
      • Update User Profiles
      • Profile Custom Attributes
      • Update user profile on sign-up using Hooks
    • Events and Hooks
      • Event List
      • Webhooks
      • JavaScript / TypeScript Hooks
      • Only Allow Signups from Inside the Corporate Network using Hooks
    • Mobile Apps
      • Use SDK to make authorized API calls to backend
      • Force authentication on app launch
      • Customize the Login Pop-up / Disable the login alert box
    • Languages and Localization
    • Custom Email and SMS Templates
    • Directly accessing Authgear Endpoint
    • Migration
      • Bulk migration
      • Rolling migration
      • Zero-downtime migration
    • Troubleshoot
      • How to Fix SubtleCrypto: digest() undefined Error in Authgear SDK
      • How to Fix CORS Error
  • Concepts
    • Identity Fundamentals
    • Authgear use cases
    • User, Identity and Authenticator
  • Security
    • Brute-force Protection
    • Bot Protection
    • Non-HTTP scheme redirect URI
    • Password Strength
  • Reference
    • APIs
      • Admin API
        • Authentication and Security
        • API Schema
        • Admin API Examples
        • Using global node IDs
        • Retrieving users using Admin API
        • User Management Examples
          • Search for users
          • Update user's standard attributes
          • Update user's picture
          • Generate OTP code
      • Authentication Flow API
      • OAuth 2.0 and OpenID Connect (OIDC)
        • UserInfo
        • Supported Scopes
      • User Import API
      • User Export API
    • Tokens
      • JWT Access Token
      • Refresh Token
    • Glossary
    • Billing FAQ
    • Rate Limits
      • Account Lockout
  • Client App SDKs
    • Javascript SDK Reference
    • iOS SDK Reference
    • Android SDK Reference
    • Flutter SDK Reference
    • Xamarin SDK Reference
  • Deploy on your Cloud
    • Running locally with Docker
    • Deploy with Helm chart
    • Authenticating HTTP request with Nginx
    • Configurations
      • Environment Variables
      • authgear.yaml
      • authgear.secrets.yaml
    • Reference Architecture Diagrams
      • Google Cloud Reference Architecture
      • Azure Reference Architecture
      • AWS Reference Architecture
      • Throughput Scaling Reference
Powered by GitBook
On this page
  • Prerequisite
  • Step 1: Enable Custom SMS Gateway
  • Step 2: Link Twilio Account Credentials
  • Step 3: Save and Test Custom SMS Provider Settings

Was this helpful?

Edit on GitHub
  1. How-To Guides
  2. Integrate
  3. Custom SMS Provider

Twilio

Use custom Twilio account as SMS provider for communication with the users.

PreviousCustom SMS ProviderNextWebhook/Custom Script

Last updated 1 month ago

Was this helpful?

In this guide, you'll learn how to set up your Authgear project to use Twilio as a custom SMS provider.

By configuring your Authgear project to use Twilio as a custom SMS provider, you switch from the default SMS provider to your own Twilio account. As a result, you can control and manage billing and other settings for your SMS from the Twilio console independent of Authgear.

Prerequisite

  • A Twilio account

  • An Authgear project with the Custom SMS Gateway feature enabled.

Note: Your project must be on an enterprise plan to use the Custom SMS Provider feature. for more details.

Step 1: Enable Custom SMS Gateway

To get started, log in to Authgear Portal, then navigate to Advanced > Custom SMS Gateway.

Next, toggle the Enable Custom SMS Gateway switch on to enable the SMS Gateway Provider settings.

Step 2: Link Twilio Account Credentials

To get your Account SID and Auth Token from Twilio, log in to your Twilio console and scroll to the Account Info section to find your Account SID, Auth Token, and Twilio phone number.

Once you have your Twilio credentials, click on Twilio from the SMS Gateway Provider list. This will open the provider's settings.

API Key

To use API Key as credential, search for "API Key" in the search bar on the top right corner of the Twilio console. Select Home > API Keys from the search result to open the API Keys page.

Click on the Create API Key button to create a new API Key.

Enter the name for your new API Key in the Friendly name text field then click Create.

Copy the SID and Secret for your new API Key and store them in a safe location. Note that you can only view your API Secret once.

Now set the following options in Authgear Portal using the details from your Twilio account:

  • Enter your Twilio Account SID.

  • Enter an SMS Sender, this can be either a Message Service ID, or your Twilio phone number, shortcode or alphanumeric sender ID that is registered on Twilio.

  • Select the type of credential you wish to use to connect to your Twilio account. This can be either an Auth Token or API Key from your Twilio console. We recommend using the API Key as the credential.

    • API Key (Recommended): Use the API Key SID and API Key Secret obtained in the Twilio's API Keys & Token page

    • Auth Token: The token is under "Account Info" in the Twilio dashboard home page

Step 3: Save and Test Custom SMS Provider Settings

Finally, click on the Save button to save your new Twilio provider settings.

To test your work, click on the Test button next to the Save button, enter your phone number then click Send to test your new SMS provider.

Note: Your project must be on an enterprise plan to use the Custom SMS Provider feature. for more details.

For this step, your Twilio account credentials such as Account SID, Auth Token (or API SID) are required. You can find these details in your console at .

Message Service ID is a feature on Twilio that lets you create multiple sender IDs based on different campaigns and conditions. Enter your Twilio Message Service ID to have Authgear use the multiple sender IDs under it. Learn more about Twilio Messaging Services .

Contact us
twilio.com
here
Contact us
authgear custom sms gateway
Twilio console account info
twilio console api keys
twilio api key details