Quick Setup Guide

Last updated: Sep 13, 2026Section: Getting Started

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, BLOG, MARKET, or SOCIAL; optionally set allowed origins; copy the project UID, integration ID, and any embed notes from Connection & settings.

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. Never put API keys in client-side JavaScript.

4. Send a test event

: Submit a synthetic form entry or open the chat widget and confirm the dashboard shows a new message.

Scenario hints

Marketing newsletter

: Use a FORM integration and post from a server route. Configure outbound SMTP if you send welcome or confirmation mail from Mailoo.

Support contact

: Use CONTACT_FORM with a restricted key and the Next.js feedback forwarding pattern (integrations/feedback-form-nextjs-example{.interpreted-text role="doc"}).

Editorial site

: Create a BLOG integration, publish an article, and fetch it from the external blog API (integrations/blog-headless-cms{.interpreted-text role="doc"}).

Realtime chat

: Configure JSBOX (optionally restrict origins to your HTTPS host) and route operators through the dashboard chat experience.

Storefront catalog

: Create a MARKET integration, add products, and call the external catalog API with market.external-read (integrations/market-catalog-external-api{.interpreted-text role="doc"}).

Social publishing

: Create a SOCIAL integration, save X and/or Facebook credentials, then compose and publish a post (integrations/social-networks{.interpreted-text role="doc"}).

Agent automation

: Create an MCP token under Profile → Security and connect your MCP host (integrations/mailoo-mcp{.interpreted-text role="doc"}).

Validation checklist

  • Integration status is Active
  • Test message or content appears with expected metadata
  • API key scopes align with each exposed webhook
  • Outbound SMTP configured before enabling subscriber replies or order email

Troubleshooting

Webhook rejected

: Re-check scopes, project UID, integration ID, and JSON payload shape.

Chat widget silent

: If Origin checks fail, verify optional allowed origins, HTTPS, and that embed IDs match the dashboard entry.

Blog or catalog API empty

: Confirm content is published for the requested locale and that the API key has the matching read scope.

Ready for more?

  • getting-started{.interpreted-text role="doc"} --- conceptual tour of Mailoo's integration model
  • Integration guides under Integrations
  • OpenAPI at https://api.mailoo.app/docs/v1