Skip to content
VaartixVaartix Docs

Quick start

You can try Vaartix before verifying a domain: test mode simulates delivery without sending real email.

  1. Get an API key

    During the private beta we create your account. Email [email protected] and you’ll receive a key starting with vx_live_. Keep it secret: store it in an environment variable, never in your code.

    Terminal window
    export VAARTIX_API_KEY="vx_live_..."

  2. Send a test email

    Send from any address at test.vaartix.com to [email protected]:

    Terminal window
    npm install vaartix
    import { Vaartix } from 'vaartix';
    

    const vaartix = new Vaartix(process.env.VAARTIX_API_KEY);
    

    const { data, error } = await vaartix.emails.send({
      from: 'Acme <[email protected]>',
      to: '[email protected]',
      subject: 'Hello from Vaartix',
      html: '<strong>It works!</strong>',
    });
    

    console.log(data ?? error); // { id: 'em_...' }

  3. Check what happened

    With a full-access key, look the email up by its ID. Within a second or two its status is delivered and its timeline shows sent then delivered.

    Terminal window
    curl https://api.vaartix.com/emails/em_... -H "Authorization: Bearer $VAARTIX_API_KEY"

  4. Send real email

    Verify your domain, then change from to an address on it, such as [email protected], and to to a real recipient.