Skip to content

Commit 1148dfc

Browse files
committed
clean up
1 parent 2539e52 commit 1148dfc

File tree

1 file changed

+31
-47
lines changed

1 file changed

+31
-47
lines changed

authentication/email.mdx

Lines changed: 31 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -157,58 +157,42 @@ const response = await client.emailAuth({
157157
});
158158
```
159159

160-
**Auth Proxy Update: appName becomes a required parameter (12/8/2025)**
160+
### Breaking Change: `appName` Required
161161

162162
<Warning>
163-
**Auth Proxy: appName becomes a required parameter**
163+
**Effective December 8, 2025**
164+
165+
Beginning the week of December 8, 2025, all email-based OTP and recovery activities will require the `appName` parameter. Existing SDK versions will continue working, but upgrading without setting an `appName` will break email-based flows.
166+
167+
<CardGroup cols={2}>
168+
<Card title="Auth Proxy Users" icon="server">
169+
**Affected:** Anyone using Auth Proxy without `appName` set
170+
171+
**Action:** Set `appName` under [email configuration](https://app.turnkey.com/dashboard/walletKit)
172+
</Card>
173+
<Card title="Server SDK Users" icon="code">
174+
**Affected:** Users calling `init_otp_auth`, `init_otp`, `email_recovery`, or `email_auth` without `appName`
175+
176+
**Action:**<br/>
177+
• For `email_recovery` or `email_auth`: include `appName` in your request<br/>
178+
• For `init_otp` or `init_otp_auth`: update your API call to match the new input structure when upgrading to the latest server-SDK
179+
</Card>
180+
</CardGroup>
181+
182+
<Accordion title="Policy activity type updates">
183+
If you manage email flows with policies, update to the new activity types:
184+
185+
| Flow | Old Activities | New Activity |
186+
|------|---------------|--------------|
187+
| EMAIL_AUTH | `ACTIVITY_TYPE_EMAIL_AUTH`, `ACTIVITY_TYPE_EMAIL_AUTH_V2` | `ACTIVITY_TYPE_EMAIL_AUTH_V3` |
188+
| INIT_OTP_AUTH | `ACTIVITY_TYPE_INIT_OTP_AUTH`, `ACTIVITY_TYPE_INIT_OTP_AUTH_V2` | `ACTIVITY_TYPE_INIT_OTP_AUTH_V3` |
189+
| INIT_OTP | `ACTIVITY_TYPE_INIT_OTP` | `ACTIVITY_TYPE_INIT_OTP_V2` |
190+
| INIT_USER_EMAIL_RECOVERY | `ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY` | `ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY_V2` |
191+
</Accordion>
164192

165-
\
166-
Beginning the week of **December 8 2025**, all new versionf of email-based OTP and recovery activities will **require the appName parameter**. Until this point the appName is optional. We’re releasing a new major version of our <u>server SDKs</u> which will introduce a **major version bump.**
167-
168-
- The **appName** will become a **required** field in updated email activities
169-
170-
Existing SDK versions will continue working, but upgrading without setting an **appName** will break email-based flows.\
171-
\
172-
**<u>Who is Affected</u>**\
173-
**Auth Proxy users**: Anyone using the Auth Proxy without an appName set
174-
175-
**Server SDK users:**
176-
177-
- Users who do not specify an appName, and/or
178-
- Any user calling email-based flows, including:
179-
- Init_otp_auth
180-
- Init_otp
181-
- Email_recovery
182-
- Email_auth
183-
184-
**<u>What You Will Need To Do</u>**
185-
186-
**Auth Proxy users:**
187-
188-
- Ensure there is an **appName** set under email configuration, [<u>here</u>](https://app.turnkey.com/dashboard/walletKit)
189-
190-
**Server-SDK users:**
191-
192-
- For those using email_recovery or email_auth
193-
- Ensure you include an **AppName** in your request
194-
- For those using init_otp or init_otp_auth: When upgrading to the newest server-SDK (a major version), you **must** update your API call to match the new input structure
195-
196-
**If you are using policies to manage email flows:**
197-
198-
- EMAIL_AUTH 
199-
- **Old activities:** ACTIVITY_TYPE_EMAIL_AUTH, ACTIVITY_TYPE_EMAIL_AUTH_V2
200-
- **New activity**: ACTIVITY_TYPE_EMAIL_AUTH_V3
201-
- INIT_OTP_AUTH
202-
- **Old activities**: ACTIVITY_TYPE_INIT_OTP_AUTH, ACTIVITY_TYPE_INIT_OTP_AUTH_V2
203-
- **New activity**: ACTIVITY_TYPE_INIT_OTP_AUTH_V3
204-
- INIT_OTP 
205-
- **Old activity**: ACTIVITY_TYPE_INIT_OTP 
206-
- **New activity**: ACTIVITY_TYPE_INIT_OTP_V2
207-
- INIT_USER_EMAIL_RECOVERY
208-
- **Old activity**: ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY
209-
- **New activity**: ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY_V2
210193
</Warning>
211194

195+
212196
### Email templates
213197

214198
We also support custom HTML email templates for [Enterprise](https://www.turnkey.com/pricing) clients on the **Scale** tier. This allows you to inject arbitrary data from a JSON string containing key-value pairs. In this case, the `emailCustomization` variable may look like:

0 commit comments

Comments
 (0)