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

string
required
The phone number the SMS should be delivered to (E.164 format).
string
required
The SMS OTP code.
string
required
The ID of the user the challenge is for.
string
required
The idempotency key of the request that created the SMS code.
string
required
The action code of the track request that created the SMS code.
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.
object
Custom data points configured for the tenant, included when a matching value is present on the action or user. Keys are prefixed by source (action_ / user_). See custom variables.