HeliosSend

Configuration

Configure your environment and application to use HeliosSend.

Environment Variables

Client Configuration

Required Configuration

Store your API Key in an environment variable:

HELIOSSEND_API_KEY=cs_YOUR_API_KEY
HELIOSSEND_API_URL=https://client.heliossend.com

Base URL

API Endpoint

https://client.heliossend.com

All API requests should be made to this base URL. The API uses HTTPS for secure communication.

Security Best Practices

Securing Your API Key

  • Never hardcode your API Key in your application code
  • Use environment variables or secure secret management systems
  • Never commit API Keys to version control
  • Rotate your API Key regularly
  • Use different API Keys for development and production
  • Monitor API usage for suspicious activity

Domain Verification

Domain Setup

Before sending emails, verify your sender domain in the HeliosSend dashboard

How to Verify Your Domain

  1. Log in to your HeliosSend dashboard
  2. Navigate to Dashboard → Domains
  3. Click "Add Domain" and enter your domain name
  4. Add the provided DNS records (SPF, DKIM) to your domain's DNS settings
  5. Wait for verification (usually takes a few minutes)

After Verification

Once your domain is verified, you can send emails from any address on that domain.

  • Use any email address from your verified domain as the sender
  • SPF and DKIM records are automatically configured for better deliverability
  • Send to any recipient email address

Error Handling

Handling Errors

HTTP Status Codes

  • 200: Success
  • 401: Invalid API Key
  • 403: Account not active
  • 404: Resource not found
  • 500: Server error or send failure

Error Response Format

{
  "detail": "Error message description"
}