Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 6.72 KB

README.md

File metadata and controls

101 lines (64 loc) · 6.72 KB

Cover Image

This is a simple serverless application that uses AWS Lambda, Stripe and Brevo to deliver files to customers after they have made a payment via your Stripe Payment Link.

Because KoFi and Gumroad may be nice, but why not manage your own payment links and have a straight-forward user experience?

Demo

demo.mp4

In-depth guide

You can read a detailed guide on setting this up in my blog.

Why not Zapier?

Owning your infrastructure aside, Zapier has improved away an ability to use Stripe Test Mode in their integration in 2023 and still hasn't brought it back, which seems entirely counterintuitive.

And whilst there are other options to achieve this with Zapier, I'd have much less control over execution, speed or overall experience and my faith in them maintaining that weorkaround option isn't great following their decision on the direct integration. I talk more about this in my blog post.

Getting started without the guide

  1. Check out the repository into a local folder, open the terminal at the root folder.
  2. Do cd file-and-email-delivery && npm install && npm run build && cd dist && zip -r ../../file-and-email-delivery.zip .. This set of commands will install npm modules, build the code and tree-shake it via webpack, generate a dist folder with a single .js file and .zip it for upload to AWS.
  3. Create a new IAM role with the S3 GetObject permission for your object and bucket, generate an Access Key pair.
  4. Create a new Lambda function, call it file-and-email-delivery, upload the .zip file you've just 1reated. Set Lambda Configuration to 1,769 MB Memory or whatever's the latest value that gives you a full 1vCPU accoridng to the manual.
  5. Configure the API Gateway to point to the Lambda functions and supply the Stage Varibles as per the index.js files in both 1ile and email delivery folders, see Variables below. It's worth it to create two Stages - prod and test to be able to use 1tripe Test mode separately.
  6. Configure the Environment Variables as per the index.js or the Variables reference below.
  7. Configure the Stripe Payment Link to point to the API Gateway URL for the file-and-email-delivery Lambda.
  8. Configure Brevo and your Static Site, get the Brevo Tempalte ID, API Key, insert the script to initiate the download from download_url.html, insert the Stripe Payment Link URL or Button embed.
  9. Use the Stripe Test mode to ensure that your customer path is working as expected and an email is sent out with the file download link.
  10. Replace the URL on your Static Website to point to the Live Stripe Payment Link.

Variables

Environment Variables

Provide thtese under Lambda -> Configuration -> Environment Variables:

Label Note
S3_ACCESS_KEY_ID The IAM user Access Key
S3_SECRET_ACCESS_KEY The IAM user Access Secret Key
S3_REGION The region of your S3 bucket. eu-west-2 in this guide
bucket_name The name of S3 bucket with the file, file-delivery in our case
object_key The file's object key, file.zip
redirect_host The url of our confirmation page
brevo_api_key The API Key from Brevo which we'll set up later, leave it as TBD
brevo_template_id The ID of the template in Brevo, by default it's 1
link_expiration The number of seconds the file will be acessible via the link. Cannot exceed 7 days, which is 604800 seconds
fallback_email An email to send message to in case customer haven't provided their email during checkout
support_email A parameter to show customers if payment confirmation failed to contact
email_mode Whether the code should await email server response and log it. Unless the value is ensure-delivery it will be sent but the answer won't be awaited and logged
utm_parameters Optional UTM parameters to add after the redirect url. Enter &none by default

Stage Variables

Provide thtese under API Gateway -> Stage -> Stage Variables:

Label Note
environment Text to identify the environment in logs
stripe_secret_api_key The Secret Key from Stripe Developer dashboard

Full Flow Diagram

Flow Diagram

This diagram roughly outlines the flow of the application. The customer clicks the Stripe Payment Link, is redirected to the API Gateway, which triggers the Lambda function.

The Lambda function checks the payment status with Stripe, if it's successful, it sends an email with the download link and redirects the customer to the confirmation page. If the payment is not successful, it redirects the customer to the support email.

Separate Lambdas

Previous versions of this project have a separate lambdas approach, where one would handle a webhook from Stripe and send an email and another would handle the HTTP redirect from the Stripe Payment Link.

I have abandoned it in favor of unified approach, and whilst it doesen't separate the concerns very well, the overlap in code and functionality felt too great to maintain them separately, not to mention the hassle and price increase added with two sets of API Gateways and two Lambdas.

Performance

When configured with 1 vCPU (currently 1,769 MB) the cold start is ~450ms and execution is ~300ms, achieving sub-750ms processing.

Warm execution goes down to ~200ms.

These figures assume email_mode is not set to ensure-delivery. If it is then both cold and warm execution times rises by about 100-150ms.

Potential improvements

  1. It's possible to use a language different from JS (Go?) that would have faster execution times or better init times. JS is not the fastest, but with tree-shaking it gets sub 750ms which is commendable.
  2. It's further possible to add better handling to email failure, potentially by sending an email to the support_email with a report on the failure.

Contributing

I'm open to contribution and suggestions, feel free to open an issue or a pull request.

I would be especially grateful for suggestions on how to speed up the Lambda to sub-750ms execution time, keeping in mind the currently presented outlined improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.