Mailflow
Get started
DEVELOPER GUIDE

From first project to delivery events

A practical sequence for integrating Mailflow into an application. Product endpoints and payloads will be documented when the backend contract is available.

  1. 01

    Create an account

    Register and access your Mailflow workspace.

  2. 02

    Create a project

    Make an isolated project for the application that sends email.

  3. 03

    Verify a sending domain

    Add the DNS records for SPF, DKIM and DMARC. Propagation and verification can take time.

  4. 04

    Generate an API key

    Create a scoped key for your project. Keep it on your server and out of frontend JavaScript and public repositories.

  5. 05

    Integrate the API

    Use the published API contract to make authenticated server-side requests. Until it exists, examples below use placeholders.

  6. 06

    Monitor delivery

    Review message states and use documented webhook events to notify your application.

ILLUSTRATIVE EXAMPLES

Server-side request shape

These samples show where integration values belong. They are not production-ready API calls.

# Illustrative only — replace placeholders with the confirmed Mailflow API contract
curl --request POST "$MAILFLOW_API_BASE_URL/$MAILFLOW_SEND_PATH" \
  --header "$MAILFLOW_AUTH_HEADER: Bearer $MAILFLOW_API_KEY" \
  --header "Content-Type: application/json" \
  --data @email-payload.json

Illustrative placeholders only. Mailflow has not published a production API contract yet.