Production

Use these checks before sending real mail from production applications.

API Key Safety

  • Store the key in a secret manager or environment variable.
  • Use WORKONWARD_API_KEY in local examples.
  • Do not commit keys, print keys, or include keys in client-side code unless the key is intentionally scoped for that use.

No-Send Smoke Test

To verify routing without queueing email, call the SDK with an intentionally invalid API key and a syntactically valid recipient. The expected result is an authentication error with server code 1001.

export WORKONWARD_API_KEY="invalid-key-for-smoke-test"

This confirms the SDK reaches the live route and parses the server envelope without sending mail.

Real Send Checklist

  • Sending domain is verified in PING8.
  • API key is active and tied to the expected template/sender.
  • Sender address belongs to the verified domain.
  • Recipient list is explicit and expected.
  • Retries are left off unless duplicate-email risk is acceptable.
  • MCP deployments keep dry-run enabled until a preview flow and recipient allowlist have been verified.

Publish Status

The SDK source lives in this repository under SDK/. Package names in these docs are the intended public names. Until registry publishing is complete, install from local source or a Git reference.

Verification Commands

cd SDK/python && python -m pytest
cd SDK/typescript && npm test
cd SDK/go && go test ./...
cd SDK/rust && cargo test
cd SDK/mcp && python -m pytest
API Reference