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

Add ability to use mailgun templates #2039

Merged
merged 8 commits into from
Dec 21, 2022
Merged

Add ability to use mailgun templates #2039

merged 8 commits into from
Dec 21, 2022

Conversation

sanders41
Copy link
Contributor

Closes #1865

Code Changes

  • Checks if a fides mailgun template exists
  • If the template exists mailguns emails are sent with the template, if not it falls back to the generic template.

Steps to Confirm

  • Create a fides template in mailgun that contains a {{{fides_email_body}}} variable (I can share my api key with whoever tests this that already has this setup).
  • Add the following variable to the docker-compose.yml
FIDES__EXECUTION__SUBJECT_IDENTITY_VERIFICATION_REQUIRED=true
FIDES__NOTIFICATIONS__NOTIFICATION_SERVICE_TYPE=mailgun
FIDES__NOTIFICATIONS__SEND_REQUEST_COMPLETION_NOTIFICATION=true
FIDES__NOTIFICATIONS__SEND_REQUEST_RECEIPT_NOTIFICATION=true
FIDES__NOTIFICATIONS__SEND_REQUEST_REVIEW_NOTIFICATION=true
  • Create a mailgun messaging config.
  • Create a privacy request and verify the identity verification email uses the mailgun template

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated:
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Issue Requirements are Met
  • Relevant Follow-Up Issues Created
  • Update CHANGELOG.md

Description Of Changes

Write some things here about the changes and any potential caveats

@sanders41 sanders41 marked this pull request as ready for review December 14, 2022 17:25
@sanders41
Copy link
Contributor Author

@conceptualshark this will need some docs updates after it is reviewed. Do we have a process for that in the new docs repo yet? Can I just update docs there as I would have in this repo?

@conceptualshark
Copy link
Contributor

@sanders41 I still have to update the issue/PR templates, but the new docs repo should work basically the same. There's a few quirks, but you should be able to make markdown edits, or open a ticket there for me to pick up!

@eastandwestwind
Copy link
Contributor

Leaving a note that I've tested pointing to a mailgun acct with the fides template, and confirmed that the template is being used:

Screen Shot 2022-12-21 at 4 52 14 PM

@sanders41 sanders41 merged commit 75dd5b9 into main Dec 21, 2022
@sanders41 sanders41 deleted the ps-mailgun-templates branch December 21, 2022 22:15
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 this pull request may close these issues.

Support ability to use email templates from Mailgun
3 participants