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.

Triggered when a challenge is created for an email-based authenticator. The data payload contains either code (for email OTP) or url (for magic link). This webhook is synchronous, so a non-2xx response fails the challenge. Open the Email OTP or Email Magic Link authenticator in authenticator settings and set the email provider to Webhook. The URL you enter as part of provider setup is where this event is delivered.

​
Payload

​
to
string
required
The email address the OTP or magic link should be delivered to.
​
code
string
The email OTP code. Present for email OTP authenticators.
​
url
string
The URL of the magic link. Present for email magic link authenticators.
​
userId
string
required
The ID of the user the challenge is for.
​
idempotencyKey
string
required
The idempotency key of the request that created the challenge.
​
actionCode
string
required
The action code of the track request that created the challenge.
​
userAgent
string
The user agent of the user who requested the challenge.
Only present if the user agent was captured when tracking an action.
​
timezone
string
The timezone of the user who requested the challenge.
Only present if the IP address was captured when tracking an action.
​
ipAddress
string
The IP address of the user who requested the challenge.
Only present if the IP address was captured when tracking an action.
​
locale
string
The locale of the user who requested the challenge.
Only present if the locale was captured when tracking an action or set on the user via update user.
{
  "version": 1,
  "id": "a3f68e12-7b4c-4d2a-9e5f-1c8b3a6d9e72",
  "source": "https://authsignal.com",
  "time": "2024-01-01T01:23:45.678Z",
  "tenantId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "type": "email.created",
  "data": {
    "to": "jane.smith@acme.com",
    "url": "https://mfa.authsignal.com/api/verify-magic-link?token=...",
    "userId": "11111111-1111-1111-1111-111111111111",
    "idempotencyKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "actionCode": "sign-in",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
    "timezone": "America/New_York",
    "ipAddress": "203.0.113.42",
    "locale": "en"
  }
}