Docs / Developer Guides
Developer Guides
CLI, APIs, webhooks, and advanced workflows for building on Colioe infrastructure.
API
REST API Reference
Every Colioe resource — mailboxes, domains, deployments, and billing — is accessible via a RESTful JSON API. Authenticate using a Bearer token obtained from your dashboard under API Keys.
- —Base URL: https://api.colioe.io/v1
- —Authentication: Authorization: Bearer <token>
- —Rate limit: 300 requests per minute per API key
- —Responses use standard HTTP status codes (200, 201, 400, 401, 404, 429)
CLI
Colioe CLI
The Colioe CLI lets you manage deployments, domains, and mailboxes from your terminal. Install it with npm or download a standalone binary.
- —Install: npm install -g @colioe/cli
- —Authenticate: colioe login
- —Deploy: colioe deploy --env production
- —List mailboxes: colioe mail list --domain yourdomain.com
- —Add domain: colioe domains add yourdomain.com
Webhooks
Incoming & Outgoing Webhooks
Subscribe to real-time events for email delivery, deployment status, and billing. Colioe sends a signed POST request to your endpoint whenever an event fires.
- —Email received: mail.inbound — fired when a new message arrives
- —Email delivered: mail.delivered — confirmed delivery to recipient
- —Deploy completed: deploy.complete — build finished successfully
- —Deploy failed: deploy.failed — build or deploy step errored
- —Verify signatures using the X-Colioe-Signature header (HMAC-SHA256)
Email API
Sending Transactional Email
Send transactional and bulk email programmatically using the Mail API. Messages are queued with automatic retry and delivery tracking.
- —Endpoint: POST /v1/messages/send
- —Required fields: from, to, subject, html or text
- —Supports CC, BCC, reply-to, attachments, and custom headers
- —Track delivery via webhooks or GET /v1/messages/{id}/status
Domains
Managing Domains via API
Add, verify, and configure domains programmatically. The API returns the exact DNS records needed for verification, MX routing, and DKIM signing.
- —Add domain: POST /v1/domains
- —List DNS records: GET /v1/domains/{id}/records
- —Verify domain: POST /v1/domains/{id}/verify
- —Delete domain: DELETE /v1/domains/{id}