Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Twilio Email (SendGrid) Templates #1866

Closed
mfbrown opened this issue Nov 28, 2022 · 2 comments · Fixed by #2728
Closed

Support Twilio Email (SendGrid) Templates #1866

mfbrown opened this issue Nov 28, 2022 · 2 comments · Fixed by #2728
Assignees

Comments

@mfbrown
Copy link

mfbrown commented Nov 28, 2022

Note: This ticket depends on #1975

Description

Our current email notifications are essentially only useful for testing; we need better templates to use for production use cases. We could write our own HTML templates for this, but we'd quickly end up wanting to provide a lot of configuration options for those templates which is a lot of work!

Meanwhile, both of our messaging providers support their own email editors to design & build transactional email templates:

For example, our current emails look like this:
image

Meanwhile, Mailgun's editor looks like this (gives users a ton of control!):
image

...with the ability to insert template variables like:
image

Assumptions

  • A single email template should be sufficient for all our emails at first
  • Each email notification would have template variables for "subject" and "message"

Acceptance Criteria

  • Add support for using Sendgrid templates for all email notifications (identity verification, request receipt, request review, request completion)
  • Add ability to automatically populate Sendgrid with a default "Fides" template (if the user does not want to create their own)
  • Add support for using Twilio templates for all email notifications (identity verification, request receipt, request review, request completion)
  • Add ability to automatically populate Twilio with a default "Fides" template (if the user does not want to create their own)

Implementation Notes/Details

For an example of how the Mailgun API works:

curl -s --user 'api:YOUR_API_KEY' \
https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages \
-F from='Sender Bob <sbob@YOUR_DOMAIN_NAME>' \
-F to='[email protected]' \
-F subject='Hello' \
-F template='template.test' \
-F t:variables='{"title": "API documentation", "body": "Sending messages with templates"}'
@rsilvery
Copy link
Contributor

@TheAndrewJackson , @SteveDMurphy we'll discuss in refinement today - going to ask Steve to take this on because we need some data map work for Andrew

@Roger-Ethyca
Copy link
Contributor

tested a while back but forgot to close. closing now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants