docs(workflows): document tracking and sensitive on code sends by Silthus · Pull Request #22088 · PostHog/posthog.com

Silthus · 2026-11-09T12:26:25Z

Note

🔵 Merge risk: low · two-way door: a docs change that a later edit corrects

Docs pages only: a wrong name or version shows readers of the transactional email pages a call that fails to compile or a version without the fields. The names and versions match the released SDKs.
Switch-off: none: live on deploy of the docs site, fix forward.

Changes

A transactional email sent with content from your code gets two new optional fields:

tracking replaces track_opens_and_clicks, which this PR documented before and which never shipped.
sensitive marks an email that carries login links, reset tokens, or codes.

Neither field changes what an existing send does.

`tracking`	Opens	Clicks	Engagement events
Left out	On	Follows `sensitive`	On
`true`	On	On	On
`false`	Off	Off	Off
`{ "opens", "clicks", "engagement" }`	`opens`, on by default	`clicks`, default follows `sensitive`	`engagement`, on by default

What the pages now say:

sensitive - A sensitive email keeps its links unchanged, leaves its subject off engagement events, and keeps no copy of its content. Left out, the email takes the setting of the template with the same key, or is sensitive when no template has that key. sensitive doesn't change opens or engagement events.
Clicks follow sensitive - When tracking leaves out clicks, PostHog tracks clicks only for an email that isn't sensitive, because a token in a tracked link would go through a redirect. "sensitive": false tracks clicks on an email without secrets. "tracking": {"clicks": true} tracks them on a sensitive email with safe links. A clicks value that the send sets wins.
false sends without the open pixel and rewritten links. PostHog can't count opens or clicks, and captures no engagement events.
Refused with a 400: an unknown key, opens: false with clicks: true, tracking together with capture_engagement, and tracking or sensitive on a template send.
capture_engagement is deprecated in favor of tracking.engagement. It still works.

Pages:

api.mdx: sensitive and tracking rows, a deprecated capture_engagement row, and new "Sensitive emails" and "Open and click tracking" sections.
The 8 SDK pages: sensitive, tracking, and a deprecated capture_engagement item, and an "Open and click tracking" section with the table in that SDK's syntax.
index.mdx: "Protect sensitive data" says how an email from your code takes the setting. The "Engagement events" item says such an email tracks clicks only when it isn't sensitive, or when tracking turns them on.

SDK names. Each page uses the names its SDK PR gives these fields. Go: Sensitive: posthog.Ptr(false), posthog.EmailTrackingOn(), posthog.EmailTrackingOff(), and posthog.EmailTrackingWith(posthog.EmailTrackingOptions{...}). .NET: Sensitive = false, EmailTracking.All, EmailTracking.None, and new EmailTracking { ... }. Rust: .sensitive(false), EmailTracking::On, EmailTracking::Off, and EmailTrackingOptions::new() builders. These names match the released Go 1.43.0, .NET 2.24.0, and Rust 0.32.0.

PostHog changes, merged and deployed:

Worker: #131756
API: #131780

The API takes tracking and sensitive, and all 8 SDK versions that send them are released. Each SDK page's "Open and click tracking" section names its first version: Python 7.89.0, Node.js 5.71.0, Go 1.43.0, Rust 0.32.0, Ruby 3.33.0, PHP 4.24.0, Elixir 2.21.0, and .NET 2.24.0. The .NET install now pins 2.24.0, and Rust pins 0.32. The other install lines already allow the new versions.

This PR changes the capture_engagement lines that #22084 also changes. The PR that merges second resolves the conflict.

Checklist

I've read the docs and/or content style guides.
Words are spelled using American English
Use relative URLs for internal links
I've checked the pages added or changed in the preview build
If I moved a page, I added a redirect in vercel.json (no page moved)

Local checks on the 10 changed files:

markdownlint-cli2 with the repo config: 0 errors.
Vale 3.13.1, CI's version: on the changed lines, only PostHogBase.EnDash on the - **Field** - bullets. These pages already use that bullet style everywhere.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Claude Code, Claude Opus 5.5 (claude-opus-5-5), as a worker in a T3 Code thread.
The behavior comes from the decided tracking and sensitive contract that the worker and API PRs above implement.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

github-actions · 2026-11-09T12:26:36Z

Deploy preview

Status	Details	Updated (UTC)
🟢 Ready	View preview	Nov 12, 2026 05:29PM

Changed pages

Page	Source
Send transactional emails	`contents/docs/workflows/transactional-emails/index.mdx`
Send transactional emails with the API	`contents/docs/workflows/transactional-emails/api.mdx`
Send transactional emails with .NET	`contents/docs/workflows/transactional-emails/dotnet.mdx`
Send transactional emails with Elixir	`contents/docs/workflows/transactional-emails/elixir.mdx`
Send transactional emails with Go	`contents/docs/workflows/transactional-emails/go.mdx`
Send transactional emails with Node.js	`contents/docs/workflows/transactional-emails/node.mdx`
Send transactional emails with PHP	`contents/docs/workflows/transactional-emails/php.mdx`
Send transactional emails with Python	`contents/docs/workflows/transactional-emails/python.mdx`
Send transactional emails with Ruby	`contents/docs/workflows/transactional-emails/ruby.mdx`
Send transactional emails with Rust	`contents/docs/workflows/transactional-emails/rust.mdx`

github-actions · 2026-11-09T12:27:08Z

Vale prose linter → found 129 errors, 23 warnings, 0 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/workflows/transactional-emails/api.mdx — 22 errors, 0 warnings, 0 suggestions

Line	Severity	Message	Rule
17:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
18:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
181:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
182:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
330:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
331:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
332:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
336:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
337:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
362:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
363:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
364:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
372:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
373:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
374:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
398:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
399:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
400:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
401:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
419:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
420:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
421:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/dotnet.mdx — 10 errors, 3 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
79:94	warning	Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept.	`PostHogBase.ProductNames`
127:20	warning	'Hangfire' is a possible misspelling.	`PostHogBase.Spelling`
184:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
185:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
208:20	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
210:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
211:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
212:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
213:26	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
230:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
231:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
232:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/elixir.mdx — 10 errors, 5 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
59:66	warning	Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept.	`PostHogBase.ProductNames`
106:20	warning	'Oban' is a possible misspelling.	`PostHogBase.Spelling`
167:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
168:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
172:336	warning	'EEx' is a possible misspelling.	`PostHogBase.Spelling`
191:21	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
193:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
194:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
195:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
196:27	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
213:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
214:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
215:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
247:32	warning	'config's' is a possible misspelling.	`PostHogBase.Spelling`

contents/docs/workflows/transactional-emails/go.mdx — 10 errors, 2 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
61:199	warning	Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept.	`PostHogBase.ProductNames`
164:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
165:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
189:20	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
191:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
192:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
193:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
194:26	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
211:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
212:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
213:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/index.mdx — 27 errors, 0 warnings, 0 suggestions

Line	Severity	Message	Rule
113:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
114:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
115:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
116:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
133:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
134:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
135:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
158:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
159:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
160:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
161:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
162:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
188:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
189:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
190:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
191:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
255:42	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
256:74	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
257:42	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
258:39	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
259:35	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
283:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
284:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
285:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
286:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
287:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
288:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/node.mdx — 10 errors, 2 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
54:72	warning	Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept.	`PostHogBase.ProductNames`
146:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
147:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
177:20	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
179:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
180:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
181:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
182:26	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
199:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
200:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
201:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/php.mdx — 10 errors, 2 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
59:67	warning	Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept.	`PostHogBase.ProductNames`
164:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
165:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
187:21	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
189:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
190:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
191:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
192:27	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
209:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
210:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
211:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/python.mdx — 10 errors, 2 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
73:89	warning	Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept.	`PostHogBase.ProductNames`
168:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
169:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
207:21	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
209:14	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
210:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
211:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
212:27	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
229:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
230:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
231:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/ruby.mdx — 10 errors, 3 warnings, 0 suggestions

Line	Severity	Message	Rule
13:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
56:215	warning	Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept.	`PostHogBase.ProductNames`
62:140	warning	'initializer' is a possible misspelling.	`PostHogBase.Spelling`
149:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
150:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
171:21	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
173:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
174:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
175:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
176:27	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
195:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
196:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
197:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`

contents/docs/workflows/transactional-emails/rust.mdx — 10 errors, 4 warnings, 0 suggestions

Line	Severity	Message	Rule
12:127	warning	Avoid trivializing words. 'easy to' can sound dismissive to the reader.	`PostHogDocs.Trivializers`
153:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
154:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
158:420	warning	'Askama' is a possible misspelling.	`PostHogBase.Spelling`
158:430	warning	'Tera' is a possible misspelling.	`PostHogBase.Spelling`
183:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
185:13	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
186:18	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
187:17	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
188:27	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
205:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
206:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
207:1	error	Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash.	`PostHogBase.EnDash`
239:33	warning	'httpmock' is a possible misspelling.	`PostHogBase.Spelling`

github-actions · 2026-11-09T12:40:18Z

Bundle report

Total JS (gzip)

12.06 MiB (+10.5 KiB / +0.1%)

Largest changed named chunks

Chunk	Gzip	Δ vs master
`1fe58427eb479d694d29950a543d39e47969ac6b.js`	58.8 KiB	new
`92e0c1085e591e90091fbb7fb7da7962902ac68a.js`	16.3 KiB	new
`component---src-templates-sdk-sdk-markdown-reference-tsx.js`	7.9 KiB	new
`9039878e5ed83c4a38ea8b069f877637312976e8.js`	7.0 KiB	new
`96de664570b44467a6d0591760da6319c7a1ad80.js`	123.2 KiB	+2.1 KiB / +1.8%
`a6a1c4eb8ff91a8865c7d8554bd65f7d03dfc244.js`	1.1 KiB	new

Eager graph (modules shipped in each entrypoint's initial chunks)

Entrypoint	Eager size	Budget	Modules
✅ `app`	10.40 MiB (-2.8 KiB / -0.0%)	report-only	1100

Largest modules in the app closure

Module	Size
`css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css`	1022.3 KiB
`./src/components/Stickers/Stickers.tsx`	696.4 KiB
`./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js`	354.8 KiB
`./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules`	351.4 KiB
`./node_modules/.pnpm/framer-motion@14.0.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/framer-motion/dist/es/render/components/motion/proxy.mjs + 126 modules`	287.2 KiB
`./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js`	281.9 KiB
`./src/components/SearchUI/index.tsx + 87 modules`	273.1 KiB
`./gatsby-browser.tsx + 59 modules`	259.3 KiB
`./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/construction-1.mjs`	248.5 KiB
`./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules`	240.2 KiB
`./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/construction-2.mjs`	228.2 KiB
`./node_modules/.pnpm/@posthog+brand@0.13.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/magnifying-glass.mjs`	221.7 KiB
`./src/hooks/useProducts.tsx + 23 modules`	153.9 KiB
`./src/hooks/useProduct.ts + 9 modules`	149.7 KiB
`./src/components/Icons/Icons.tsx`	147.4 KiB

Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes for the modules actually shipped in the entrypoint's initial chunks (post-tree-shake).

Code sends never get click tracking, so false only drops PostHog's open pixel. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Replace track_opens_and_clicks with tracking on the API page and every SDK page: true, false, or an object with opens, clicks and engagement. Clicks stay off by default, because a link can carry a sign-in or reset token. capture_engagement is deprecated in favor of tracking.engagement. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Go builds custom tracking with EmailTrackingWith(EmailTrackingOptions{}), Rust has EmailTracking::On and Off with EmailTrackingOptions builders, and .NET names its constants EmailTracking.All and EmailTracking.None. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog

PostHog Review · Standard · reviewed 5a881b0: 1 Should fix.

See this review and its findings in PostHog Review. Comment @posthog review --deep for a Deep review. A Deep review takes longer and looks deeper than a Standard review.

posthog · 2026-11-10T08:29:44Z

 - **`From`** - Needs an address on a domain that your project verified. Without it, PostHog uses the project's default sender. `ReplyTo` takes a list of addresses.
- **`CaptureEngagement`** - PostHog captures the email's engagement events unless you set it to `posthog.Ptr(false)`.
+- **`Tracking`** - What PostHog tracks for the email. If you leave it out, PostHog tracks opens, not clicks, and captures engagement events. See [open and click tracking](#open-and-click-tracking).
+- **`CaptureEngagement`** - Deprecated. Set `Tracking: posthog.EmailTrackingWith(posthog.EmailTrackingOptions{Engagement: posthog.Ptr(false)})` instead. It still works, but a send that sets both `CaptureEngagement` and `Tracking` gets an error.


P2 · Specify the SDK versions required for tracking

For readers using Go v1.40.0, the minimum version this page documents, the replacement fails to compile: CodeEmail has no Tracking field or EmailTrackingWith helper. Node.js 5.62.0 likewise lacks tracking. Releasing newer SDKs doesn't resolve guidance for existing installations; state the tracking-specific minimum version on each SDK page.

Valid. No SDK version takes tracking yet, so there is no number to write. This PR stays a draft until those versions ship, and the description now lists adding the first version that takes tracking to each SDK page as a step before merge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

A code send takes an optional sensitive flag. Left out, it follows the template with the same key, or is sensitive when no template has it. Clicks follow sensitive unless tracking sets them, so the pages no longer say clicks are always off by default for code sends. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Keeps master's Ruby migrated_from note before the open and click tracking section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…ensitive Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

… tracking Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

posthog

PostHog Review · Standard · reviewed bf75c7d: 1 Should fix.

posthog · 2026-11-12T17:12:56Z

+- **A template has the same key** - When a template in your project has the key that you send as `template_key`, the email takes that template's [**Protect sensitive data**](/docs/workflows/transactional-emails#protect-sensitive-data) setting.
+- **No template has the key** - The email is sensitive.
+
+Send `"sensitive": false` for an email that carries no secrets, such as an order confirmation. PostHog then tracks its clicks too, as it does for a template without **Protect sensitive data**. `sensitive` doesn't change opens or engagement events.


P2 · Document the restriction on overriding a sensitive template

When template_key matches a template with Protect sensitive data enabled, sending sensitive: false returns HTTP 400 and sends nothing. The deployed API's _code_email_workflow_id explicitly rejects this override, contrary to this guidance and the SDK copies. Document this restriction and tell readers to unmark the template before sending false.

#22088 merged and #22084 closed, so no open PR rewrites the capture_engagement, from, and engagement bullets any more. Change their hyphens to en dashes, and the hyphens in the new bullets that #22088 and #21984 added. The "Copies and attachments" list in api.mdx stays as it is. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(workflows): use en dashes in the transactional email docs Replace the hyphen that separates a term from its description with an en dash, as the style guide and Vale's EnDash rule require. Change "rules that are easy to get wrong" to "rules that agents often get wrong". Leave the "Copies and attachments" list in api.mdx and the capture_engagement and engagement bullets alone: other open PRs rewrite those lines. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(workflows): use en dashes on the lines that are now free #22088 merged and #22084 closed, so no open PR rewrites the capture_engagement, from, and engagement bullets any more. Change their hyphens to en dashes, and the hyphens in the new bullets that #22088 and #21984 added. The "Copies and attachments" list in api.mdx stays as it is. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(workflows): use en dashes on the bullets that Vale misses Vale's EnDash rule needs a letter before " - ", so it misses a bullet whose term ends in bold or code, such as "**API** - Copy" and "**`text`** - If". The review panel found 9 of them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

docs(workflows): document track_opens_and_clicks on code sends

2322564

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

github-actions Bot added docs Improvements or additions to product documentation, "Docs" content PR only touches files under contents/ labels Nov 9, 2026

Silthus and others added 2 commits November 9, 2026 13:06

docs(workflows): say track_opens_and_clicks removes only the open pixel

93437ed

Code sends never get click tracking, so false only drops PostHog's open pixel. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Silthus changed the title ~~docs(workflows): document track_opens_and_clicks on code sends~~ docs(workflows): document the tracking option on code sends Nov 10, 2026

posthog Bot reviewed Nov 10, 2026

View reviewed changes

Silthus and others added 2 commits November 10, 2026 08:36

docs(workflows): keep the Go tracking table within the page width

a51bee4

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Silthus changed the title ~~docs(workflows): document the tracking option on code sends~~ docs(workflows): document tracking and sensitive on code sends Nov 11, 2026

Merge origin/master into docs/emails-track-opens-and-clicks

47dec6c

Keeps master's Ruby migrated_from note before the open and click tracking section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Silthus mentioned this pull request Nov 11, 2026

docs(workflows): use en dashes in the transactional email docs #22166

Merged

Silthus and others added 2 commits November 12, 2026 18:09

docs(workflows): name the first SDK versions that take tracking and s…

7dbd6d9

…ensitive Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

docs(workflows): pin the .NET and Rust installs to versions that take…

bf75c7d

… tracking Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Silthus marked this pull request as ready for review November 12, 2026 17:11

posthog Bot reviewed Nov 12, 2026

View reviewed changes

Silthus merged commit 0bf7b0e into master Nov 12, 2026
28 checks passed

Silthus deleted the docs/emails-track-opens-and-clicks branch November 12, 2026 17:39

Navigation Menu

Repository navigation

docs(workflows): document tracking and sensitive on code sends - #22088

docs(workflows): document tracking and sensitive on code sends#22088
Silthus merged 9 commits into
masterfrom
docs/emails-track-opens-and-clicks

Silthus commented Nov 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Nov 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Nov 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Nov 9, 2026 •

edited

Loading

Uh oh!

posthog Bot left a comment

Uh oh!

posthog Bot Nov 10, 2026

Uh oh!

Silthus Nov 10, 2026

Uh oh!

posthog Bot left a comment

Uh oh!

posthog Bot Nov 12, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

Silthus commented Nov 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Checklist

🤖 Agent context

Uh oh!

github-actions Bot commented Nov 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploy preview

Changed pages

Uh oh!

github-actions Bot commented Nov 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle report

Total JS (gzip)

Eager graph (modules shipped in each entrypoint's initial chunks)

Uh oh!

posthog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

posthog Bot Nov 10, 2026

Choose a reason for hiding this comment

Uh oh!

Silthus Nov 10, 2026

Choose a reason for hiding this comment

Uh oh!

posthog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

posthog Bot Nov 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Silthus commented Nov 9, 2026 •

edited

Loading

github-actions Bot commented Nov 9, 2026 •

edited

Loading

github-actions Bot commented Nov 9, 2026 •

edited

Loading

github-actions Bot commented Nov 9, 2026 •

edited

Loading