chore: import upstream snapshot with attribution

2026-07-13 13:34:48 +08:00
commit 77bb5bf71f
3762 changed files with 353249 additions and 0 deletions
@@ -0,0 +1,53 @@
+# Resend Integration
+
+## Overview
+
+`@botpresshub/resend` is an integration that allows a Botpress chatbot to send emails via the Resend API.
+
+## Configuration
+
+### Authenticating your domain (https://resend.com/domains)
+
+1. Login to the Resend dashboard (https://resend.com/)
+2. In the navigation bar on the left, click on "Domains"
+3. Near the top-right, click "Add Domain"
+4. In the "Name" field, enter your domain (e.g. "Botpress.com")
+5. (Optional) Select the server region closest to your user base
+6. (Optional) Customize the return path (Only recommended if you know what this does)
+7. Click "Add Domain" (Below "Advanced options")
+8. Add the DNS records in the portal of your domain provider (e.g. SquareSpace, GoDaddy, etc.)
+   1. While the DMARC record is optional, it's recommended to protect against spoofing/unauthorized use of the domain
+9. Click "I've added the records" and wait for each status to be marked as "Verified"
+10. Now you're ready to send emails with your domain. Happy Emailing!
+
+### Acquiring an API key (https://resend.com/api-keys)
+
+1. Login to the Resend dashboard (https://resend.com/)
+2. In the navigation bar on the left, click on "API Keys"
+3. Near the top-right, click "Create API Key"
+4. Give the key a name & grant the key "Sending Access"
+   1. Optionally, choose which domains you want the key to send emails through
+5. Click "Add" to generate the API Key
+6. Copy the resulting API key into a secure location as it will only be shown once
+
+### Setting up Webhooks (https://resend.com/webhooks)
+
+1. Login to the Resend dashboard (https://resend.com/)
+2. In the navigation bar on the left, click on "Webhooks"
+3. Near the top-right, click "Add Webhook"
+4. Copy the webhook URL from the Botpress integration config & paste it into Resend's "Endpoint URL" input field
+5. Select which webhook events you want to listen for
+6. Click "Add" (Below the "Select events to listen" section)
+7. (Optional, but recommended) Copy the "Signing Secret" from Resend and paste it into the "Webhook Signing Secret" of the Botpress integration config
+8. Now your bot is ready to listen for events from Resend
+
+## Side Notes
+
+The current implementation is limited to only sending [markdown](https://spec.commonmark.org/0.31.2/) rich-text emails, though this will be expanded upon in the future.
+
+## Resources
+
+- https://resend.com/docs/introduction
+- https://resend.com/docs/dashboard/domains/introduction
+- https://resend.com/docs/dashboard/api-keys/introduction
+- https://resend.com/docs/dashboard/emails/send-test-emails