email.created

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

string

required

The email address the OTP or magic link should be delivered to.

string

The email OTP code. Present for email OTP authenticators.

string

The URL of the magic link. Present for email magic link authenticators.

string

required

The ID of the user the challenge is for.

string

required

The idempotency key of the request that created the challenge.

string

required

The action code of the track request that created the challenge.

string

The user agent of the user who requested the challenge.

Only present if the user agent was captured when tracking an action.

string

The timezone of the user who requested the challenge.

Only present if the IP address was captured when tracking an action.

string

The IP address of the user who requested the challenge.

Only present if the IP address was captured when tracking an action.

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.

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 template variables.

{
  "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",
    "customVariables": {
      "action_transactionAmount": "100.00",
      "user_accountId": "acct_123"
    }
  }
}

{
  "version": 1,
  "id": "b7d29a45-3e1f-4c8b-a6d2-9f5e1c3b7a84",
  "source": "https://authsignal.com",
  "time": "2024-01-01T01:23:45.678Z",
  "tenantId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "type": "email.created",
  "data": {
    "to": "john.doe@example.org",
    "code": "847291",
    "userId": "11111111-1111-1111-1111-111111111111",
    "idempotencyKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "actionCode": "transfer-funds",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
    "timezone": "Europe/London",
    "ipAddress": "198.51.100.17",
    "locale": "en",
    "customVariables": {
      "action_transactionAmount": "100.00",
      "user_accountId": "acct_123"
    }
  }
}

sms.createdSent when an SMS OTP needs to be delivered through your own SMS provider.

⌘I

{
  "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",
    "customVariables": {
      "action_transactionAmount": "100.00",
      "user_accountId": "acct_123"
    }
  }
}

{
  "version": 1,
  "id": "b7d29a45-3e1f-4c8b-a6d2-9f5e1c3b7a84",
  "source": "https://authsignal.com",
  "time": "2024-01-01T01:23:45.678Z",
  "tenantId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "type": "email.created",
  "data": {
    "to": "john.doe@example.org",
    "code": "847291",
    "userId": "11111111-1111-1111-1111-111111111111",
    "idempotencyKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "actionCode": "transfer-funds",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
    "timezone": "Europe/London",
    "ipAddress": "198.51.100.17",
    "locale": "en",
    "customVariables": {
      "action_transactionAmount": "100.00",
      "user_accountId": "acct_123"
    }
  }
}

Webhooks

Authenticator challenge events

Authenticator events

Action verification events

Log events

Payload

​Payload

Payload