Charchy Senddocs

Charchy Send

Transactional email for your app — sign-in codes, password resets, receipts and order updates — sent from your own domain.

Charchy Send is an email API. Your server calls one endpoint; the email leaves from your own domain, signed with your DKIM key. Every email's life shows in the dashboard and reaches your server as signed webhooks.

import { CharchySend } from "@charchy/send"

const send = new CharchySend() // reads CHARCHY_SEND_KEY

await send.emails.send(
  {
    from: "Darin Game <hello@daringaming.com>",
    to: "customer@example.com",
    subject: "Your sign-in code: 482910",
    text: "Your code is 482910. It expires in 10 minutes.",
  },
  { idempotencyKey: "signin-code/1842" }
)
{ "id": "em_8f2k1x9q4w7m3n5p6r0s2t4v", "status": "queued" }

What it is for

Transactional email — mail a person's own action or account triggers:

  • Sign-in and verification codes
  • Password resets
  • Receipts and invoices
  • Order, shipping and booking confirmations
  • Account alerts

Newsletters, offers and announcements are marketing: they go through Charchy Campaigns, not this API. See Sending emails for where the line is.

Why Charchy Send

  • Kurdish and Arabic work in the subject, the body and the sender's display name ("دارین گەیم <hello@daringaming.com>").
  • Built for codes that expire. Set expires_at; if the email can't leave in time, we drop and refund it. A sign-in code 20 minutes late is worse than none.
  • Free test mode. Test keys and the @sim.charchy.krd magic addresses let you build and run CI without sending a real email or spending a credit.
  • A lower price at volume. Pricing starts at $9 a month.

How it works

  1. Add your domain and publish three DNS records (or click Add with Cloudflare). Domains & DNS
  2. Create an API key. Test keys start with chy_test_, live keys with chy_live_. Server only — never in browser or mobile code.
  3. Send with POST /v1/emails, or up to 100 at once with POST /v1/emails/batch.
  4. Listen for email.delivered, email.bounced and the other webhook events, or read an email's timeline with GET /v1/emails/{id}.

The basics

Base URLhttps://api.charchy.krd/v1
AuthenticationAuthorization: Bearer <your API key>
FormatJSON in, JSON out, UTF-8
DuplicatesSend an Idempotency-Key header on every request
Errors{ "error": { "code", "message", "docs" } } — every code is on the Errors page
Rate limit10 requests a second per workspace, bursts of 20

Getting access

Charchy Send is invite-only for now: we set up each client by hand and check your domain and first emails before you go live. Request access — your website, what your app sends and how many emails a month. Approved requests get an invitation by email. Test mode is free while you build.

On this page