Skip to main content
Triggered when a challenge is created for the SMS OTP authenticator. This webhook is synchronous, so a non-2xx response fails the challenge. Open the SMS OTP authenticator in authenticator settings and set the SMS provider to Webhook. The URL you enter as part of provider setup is where this event is delivered.

​
Payload

​
to
string
required
The phone number the SMS should be delivered to (E.164 format).
​
code
string
required
The SMS OTP code.
​
userId
string
required
The ID of the user the challenge is for.
​
idempotencyKey
string
required
The idempotency key of the request that created the SMS code.
​
actionCode
string
required
The action code of the track request that created the SMS code.
​
locale
string
The locale of the user who requested the SMS code.
Only present if the locale was captured when tracking an action or set on the user via update user.
{
  "version": 1,
  "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "source": "https://authsignal.com",
  "time": "2024-01-01T01:23:45.678Z",
  "tenantId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "type": "sms.created",
  "data": {
    "to": "+123456789",
    "code": "987654",
    "userId": "11111111-1111-1111-1111-111111111111",
    "idempotencyKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "actionCode": "sign-in",
    "locale": "en"
  }
}