Back to Supabase

MessageBirdConfig

apps/docs/components/AuthSmsProviderConfig/MessageBirdConfig.mdx

1.26.042.6 KB
Original Source

import { Admonition } from 'ui-patterns/admonition' import { CostWarning } from './AuthSmsProviderConfig.Warnings'

<Admonition type="warning">

The MessageBird provider only works with the APIs before the transition to Bird. If you are using a new Bird account, this provider will not work properly since it relies on using the old set of MessageBird APIs.

</Admonition>

Prerequisites

You'll need:

  • A MessageBird account (sign up here)
  • A Supabase project (create one here)
  • A mobile phone capable of receiving SMS
<CostWarning />

Set up MessageBird as your SMS provider

Start by logging into your MessageBird account and verify the mobile number you'll be using to test with here. This is the number that will be receiving the SMS OTPs.

Navigate to the dashboard settings to set the default originator. The messagebird originator is the name or number from which the message is sent. For more information, you can refer to the messagebird article on choosing an originator here

You will need the following values to get started:

  • Live API Key / Test API Key
  • MessageBird originator

Now go to the Auth > Providers page in the Supabase dashboard and select "Phone" from the Auth Providers list.

You should see an option to enable the Phone provider.

Toggle it on, and copy the 2 values over from the Messagebird dashboard. Click save.

<Admonition>

If you use the Test API Key, the OTP will not be delivered to the mobile number specified but messagebird will log the response in the dashboard. If the Live API Key is used instead, the OTP will be delivered and there will be a deduction in your free credits.

</Admonition>

SMS custom template

The SMS message sent to a phone containing an OTP code can be customized. This is useful if you need to mention a brand name or display a website address.

Go to Auth > Templates page in the Supabase dashboard.

Use the variable .Code in the template to display the code.