Quick Setup Guide
Quick Setup Guide
Use this checklist when you want a working Mailoo footprint in a single sitting.
Prerequisites
- Mailoo account with dashboard access
- A project created for your workspace
- API keys generated with the scopes each webhook requires
Five-minute flow
1. Project hygiene (1 minute)
: Confirm naming, copy the projectUid, and decide who rotates keys.
2. Create the integration (2 minutes)
: Add FORM, CONTACT_FORM, JSBOX, or BLOG, set allowed origins, and capture webhook URLs or embed snippets.
3. Wire your backend (2 minutes)
: Store X-API-Key in environment variables, forward form posts from a BFF, or embed the chat loader on your marketing site.
4. Send a test event
: Submit a synthetic form entry or open the chat widget locally and confirm the dashboard shows a new message.
Scenario hints
Marketing newsletter
: Use a FORM integration, post from a server route, and attach templates if you send confirmations from Mailoo.
Support contact
: Use CONTACT_FORM with a restricted key and the documented Next.js forwarding pattern.
Editorial site
: Create a BLOG integration, publish a draft article, and hit the external blog API from your static site generator.
Realtime chat
: Configure JSBOX, restrict origins to your HTTPS host, and route operators through the dashboard chat experience.
Validation checklist
- Integration status is Active
- Test message stored with expected metadata
- API key scopes align with each exposed webhook
- Outbound SMTP configured before enabling subscriber replies
Troubleshooting
Webhook rejected
: Re-check scopes, project UID, integration ID, and JSON payload shape.
Chat widget silent
: Verify allowed origins, HTTPS, and that embed IDs match the dashboard entry.
Blog API empty
: Confirm content is published for the requested locale and slugs match the integration routes.
Ready for more?
getting-started{.interpreted-text role="doc"} --- conceptual tour of Mailoo's integration model- Integration-specific Markdown under
apps/web/src/content/docs/<locale>/integrations(seepnpm docs:convert) - Operator environment variables documented in
../../development/environment{.interpreted-text role="doc"}