Developer Integration Guide
Documentation, help guides, integration planning, webinars, blog insights, and practitioner resources - all in one place.
Developer Integration Guide
Guidance for secure API access, webhooks, payload mapping, and customer-directed integrations.
Open Developer GuideMessages
Contacts
Comprehensive Reference Guide & Architecture
Deep-dive technical walkthroughs, configuration parameters, and best practices.
1Developer Integration & Interface Reference Guide
AxoDesk provides a robust developer API and webhook engine designed to connect your customer conversation workspace with custom internal CRM systems, order databases, and transaction gateways. This guide covers authentication models, rate limit specifications, event-driven webhooks, and contact data schema mapping. Use these APIs to sync records, trigger broadcasts, and verify webhook delivery.
2Authentication, Access Levels, & Sandbox Operations
All API requests require Bearer tokens authorized in Settings > Developer. We support two primary access models: restricted workspace tokens for individual pipelines, and organization tokens for full multi-tenant tenant administration. To prevent key leakage, rotate tokens periodically in settings. We recommend using a sandbox workspace to test API responses, webhook payloads, and database mapping before routing production-level traffic.
3Rate Limiting & Performance Management
To ensure system availability across tenants, AxoDesk enforces rate limits on all endpoints. Standard API requests are limited to 120 calls per minute per workspace, with burst capacities allowed up to 180 calls. High-volume template broadcasts should pacing dispatch calls to prevent Meta API throttling. If your rate limits are exceeded, the API returns a 429 status code with a Retry-After header. Implement exponential backoff in your code to handle rate limiting gracefully.
4Event-Driven Webhooks & Payload Validation
AxoDesk's webhook registry dispatches real-time event payloads for messages (sent, delivered, read, failed), contact updates, and campaign completions. Endpoints must return an HTTP 200 OK within 3 seconds to verify receipt. If an endpoint fails or times out, AxoDesk schedules retry attempts at increasing intervals. Webhook payloads contain an X-AxoDesk-Signature header generated using HMAC-SHA256, allowing your servers to validate that requests originate from AxoDesk.
5Contact Data Model & Field Mapping Contracts
The contact data model uses a structured schema mapping names, phones, emails, and custom attributes. Custom attributes must follow defined field contract validation rules (string, boolean, numeric, date) before they can be updated via API. Reconciling client data after checkout events (like shopify checkout creation) allows relationship managers to view correct attributes in the shared inbox.
Featured: AxoDesk Enterprise Legal Center
Public ReviewReview privacy, data processing, acceptable-use, security, and third-party information for AxoDesk.
Workflow ideas and implementation guidance
Join the AxoDesk Community
Share automation templates, ask questions, swap growth strategies, and learn from practitioners running AxoDesk at scale.