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

Allow tailoring of the api key signup e-mail message #133

Closed
GUI opened this issue Oct 7, 2014 · 1 comment
Closed

Allow tailoring of the api key signup e-mail message #133

GUI opened this issue Oct 7, 2014 · 1 comment

Comments

@GUI
Copy link
Member

GUI commented Oct 7, 2014

When a user signs up, they receive a confirmation e-mail with the api key in it. The body of this message should be configurable so that when the api key signup form is embedded on another site, they can tailor the message how they want. We allow this type of customization on the web signup page (for example, the message can contain a different example URL or a different message body), so we need to offer similar customization for the e-mail message (and maybe use the same parameters used to customize the webpage?).

This came up with the Auctions API embedding the signup page, so see here for a bit more context: GSA/auctions_api#12 (comment)

@GUI GUI added the enhancement label Oct 7, 2014
@GUI GUI self-assigned this Oct 7, 2014
@GUI GUI added this to the Sprint 19 (4/6-4/17) milestone Apr 6, 2015
@GUI
Copy link
Member Author

GUI commented Apr 19, 2015

The new options are documented in the updated snippet here: https://github.com/18F/api.data.gov/wiki/User-Manual:-Agencies#embedding-the-api-key-signup-form-on-your-own-documentation-site (all of the new "OPTIONAL" settings).

In general, the e-mail messages should be improved for all of our existing users without them having to do anything. The custom exampleApiUrl value that agencies were already setting in their embedded forms will automatically be the URL used in the e-mails now. In addition to that improvement, there are new options to further tailor and brand the confirmation page and welcome e-mail message (contactUrl, sendWelcomeEmail, siteName, and emailFromName). I've also belatedly documented a previous option we had (signupConfirmationMessage).

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

No branches or pull requests

1 participant