feat: customer io email support #28578
Open
+180
−20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR introduces Customer.io as a new email service provider, replacing Mailgun for transactional emails, with implementation focused on API integration and backward compatibility with existing SMTP functionality.
- Added Customer.io API integration in
/posthog/email.pywith new_send_via_httpfunction and service availability checks - Implemented Decimal to float conversion in
/posthog/email.pyfor proper JSON serialization in Customer.io payload - Added
CUSTOMER_IO_API_KEYconfiguration in/ee/settings.pyfor enterprise deployment support - Added comprehensive HTTP-based email sending tests in
/posthog/test/test_email.pycovering API authentication and data handling - Maintained backward compatibility by preserving SMTP functionality with a
use_httptoggle flag
3 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -44,6 +44,8 @@ | |||
| # This is because in the demo env social signups get is_staff=True to facilitate instance management | |||
| SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS = ["posthog.com"] | |||
|
|
|||
| CUSTOMER_IO_API_KEY = get_from_env("CUSTOMER_IO_API_KEY", "", type_cast=str) | |||
There was a problem hiding this comment.
style: Consider adding documentation comments above this setting to explain its purpose and whether it's required for cloud vs self-hosted setups
Comment on lines
+93
to
+94
| if not customerio_api_key: | ||
| raise Exception(f"Missing Customer.io API key: {customerio_api_key}") |
There was a problem hiding this comment.
logic: Logging the API key in the error message could expose sensitive information
Suggested change
| if not customerio_api_key: | |
| raise Exception(f"Missing Customer.io API key: {customerio_api_key}") | |
| if not customerio_api_key: | |
| raise Exception("Missing Customer.io API key") |
|
|
||
| response = requests.post("https://api.customer.io/v1/send/email", headers=api_headers, json=payload) |
There was a problem hiding this comment.
style: Consider using settings.CUSTOMER_IO_BASE_URL instead of hardcoding the API endpoint
Comment on lines
+101
to
+136
| try: | ||
| for dest in to: | ||
| with transaction.atomic(): | ||
| record, _ = MessagingRecord.objects.get_or_create( | ||
| raw_email=dest["raw_email"], campaign_key=campaign_key | ||
| ) | ||
|
|
||
| record = MessagingRecord.objects.select_for_update().get(pk=record.pk) | ||
| if record.sent_at: | ||
| continue | ||
|
|
||
| properties = { | ||
| "subject": subject, | ||
| "body": html_body, | ||
| "reply_to": reply_to or get_instance_setting("EMAIL_REPLY_TO"), | ||
| **headers, | ||
| } | ||
|
|
||
| # Convert any Decimal values to float for JSON serialization | ||
| properties = {k: float(v) if isinstance(v, Decimal) else v for k, v in properties.items()} | ||
|
|
||
| payload = { | ||
| "transactional_message_id": campaign_key, | ||
| "to": dest["raw_email"], | ||
| "identifiers": {"email": dest["raw_email"]}, | ||
| "message_data": properties, | ||
| } | ||
|
|
||
| response = requests.post("https://api.customer.io/v1/send/email", headers=api_headers, json=payload) | ||
|
|
||
| if response.status_code != 200: | ||
| raise Exception(f"Customer.io API error: {response.status_code} - {response.text}") | ||
|
|
||
| record.sent_at = timezone.now() | ||
| record.save() | ||
|
|
There was a problem hiding this comment.
style: Transaction block is unnecessarily large - move the API call outside
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
We're consolidating email sending into customer.io so moving off Mailgun. Billing emails are already using this and it's working well. This is adding the basic setup. Future PRs will enable this for a few emails.
👉 Stay up-to-date with PostHog coding conventions for a smoother review.
Does this work well for both Cloud and self-hosted?
Built this as an alternative to the existing STMP
How did you test this code?
Added a few unit tests