API Reference
Integrate third-party products with Donutwork billing, identity, automation, communications, AI, and operational APIs.
Build a server-to-server integration with Donutwork billing, identity, workflow, communications, AI, and operational services. Start with the quickstart, follow the guided flows for customer billing, payment events, and email, then read integration fundamentals before shipping production traffic.
The reference follows the registered Public API routes. Each endpoint shows its required scope, request contract, and cURL, server-side JavaScript, and PHP examples. Replace the sample resource IDs and values before sending a request; OpenAPI examples are illustrative rather than exhaustive validation schemas. Copilot additionally requires a user-bound identity: see the Copilot API.
Choose an integration surface
Identity Provider (IDP)
Manage user identities with native MFA and TOTP support. Explore IDP →
Key Management Service (KMS)
Store and reveal sensitive credentials with strict IP whitelisting. Explore KMS →
Email Gateway
Transactional Intelligence. Trigger localized templates with dynamic variable injection. Scale communications via high-deliverability routes. Explore Email →
AI Gateway
Provider-neutral AI orchestration. Configure assistants, knowledge retrieval, stored conversations, usage, and budgets behind stable public APIs. Explore AI Gateway →
AI Agents
Persistent digital collaborators. Define responsibilities, publish bounded permissions, start runs, and manage exact-action approvals. Explore AI Agents →
GeoIP & Metadata
Localized Intelligence. Resolve IPv4 to precise geographic data and rich country metadata for automated compliance and tax logic. Explore GeoIP →
Growth & Operations
Share Secrets
One-time encrypted payload sharing with automatic purge.
Shortlinks
URL redirection with traffic attribution.
Taxes
VAT and sales tax logic for billing compliance.
DNS
Multi-resolver DNS diagnostics and propagation checks.
Mobile Push
Register and revoke iOS push tokens for mobile clients.
Enterprise Orchestration
Content Box
Model custom data structures and serve them via a unified JSON API. Explore Content Box →
Workflow
Automate business logic with stage-based auditing and dynamic payload injection. Explore Workflow →
Integration Architecture
| Metric | Specification |
|---|---|
| Production origin | https://api.hub.donutwork.com |
| Authentication | Bearer API key over HTTPS |
| Default Version | 2026-02-01 |
| Data format | JSON unless the endpoint states otherwise |
| Tenant boundary | Company attached to the API key |
| Traceability | X-Request-Id on every response |
Before you build
- Obtain separate staging and production API keys.
- Select only the scopes required by your use case.
- Complete the quickstart and persist the returned resource IDs.
- Implement the common error, rate-limit, and retry rules.
- Use the OpenAPI document to validate generated clients, but treat the endpoint pages as the operational guide.