Other SMS providers (SMS gateway)

[fungc-io]

Problem

Allow user to use their own SMS gateway for sending messages. This feature is supported in the backend in https://github.com/authgear/authgear-server/issues/2829 In this pitch, we are adding the configuration in the portal and the relevant documentation

Appetite

2 weeks

Solution

User can choose from the following providers in the portal

• Built-in SMS of Authgear
• Your own Twilio account
• Custom

If the latter 2 are selected, some configurations presented in the portal

Twilio

Twilio is the most popular service, the user will only need to provide:

• Application SID
• AuthToken
• Messaging Service SID

Custom It's supported the SMS messaging hook. There are 2 modes:

• Webhook
  • User should specify a URL to handle the webhook
  • The user should validate the webhook by the signature as other webhooks do.
  • The payload is a JSON with these fields
  • to: The recipient of the sms.
  • body: The body of the sms.

    {
    "to": "+85298765432",
    "body": "You OTP is 123456"
    }

• Javascript/TypeScript
  • This is a custom script that will be executed when a message is triggered
  • Example:

import { CustomSMSGatewayPayload } from "https://deno.land/x/authgear-deno-hook@0.1.0/mod.ts";

export default async function (e: CustomSMSGatewayPayload): Promise<void> {
  const response = await fetch("https://some.sms.gateway");
  if (!response.ok) {
    throw new Error("Failed to send sms");
  }
}

Rabbit holes

Details about the solution worth calling out to avoid problems

No-goes

Functionality or use cases we intentionally aren’t covering to fit the appetite

[hlh112]

@fungc-io figma updated

[fungc-io]

Thanks @hlh112, it looks good, left a trivial comment in the figma Can you also create a sample screen for revamping the header position?

Similar to what we did here: https://www.figma.com/file/msiE4O5imHONAG5EjhZeiZ/Authgear-UI?type=design&node-id=9245%3A97825&mode=design&t=OxPjMLhmxCz9mikV-1

[hlh112]

@fungc-io both comments updated~

[fungc-io]

lgtm, thanks!