Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt

Use this file to discover all available pages before exploring further.

Fired when an existing authenticator on a user is updated, such as when the user’s SMS channel switches between SMS and WhatsApp. This webhook is asynchronous. If your endpoint returns a non-2xx response, it is retried up to 3 times, at least 30 seconds apart. Configure the webhook URL for authenticator events in tenant settings.

​
Payload

​
userId
string
required
The ID of the user the authenticator was updated for.
​
verificationMethod
string
required
The verification method of the authenticator that was updated.
​
updatedAt
string
required
The time the authenticator was updated in ISO 8601 format.
​
userAuthenticatorId
string
required
A unique ID for the user authenticator that was updated.
​
previousSmsChannel
string
The last channel that was used to successfully complete an SMS OTP challenge. Either DEFAULT (regular SMS) or WHATSAPP.
​
email
string
The email address associated with the authenticator. Included for email OTP and magic link authenticators.
​
phoneNumber
string
The phone number associated with the authenticator. Included for SMS and WhatsApp authenticators.
​
credentialId
string
The passkey credential ID. Only included for passkey authenticators.
​
aaguid
string
The AAGUID of the authenticator that created the passkey. Only included for passkey authenticators.
​
credentialName
string
A display name for the passkey authenticator, such as the device or credential manager name. Only included for passkey authenticators.
{
  "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": "authenticator.updated",
  "data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "verificationMethod": "SMS",
    "updatedAt": "2024-01-01T01:23:45.678Z",
    "userAuthenticatorId": "cccccccc-cccc-cccc-cccc-cccccccccccc",
    "previousSmsChannel": "WHATSAPP",
    "phoneNumber": "+12345678901"
  }
}