.png)
CleverTap Integration Guide
Connect CleverTap with enterprise systems through regional REST APIs, batch uploads, selected webhook notifications, and Martini workflows.
CleverTap integration options at a glance
CleverTap provides regional REST APIs for user profile updates, event ingestion, selected platform operations, and batch uploads. Upload APIs support multiple profile or event records per request for initial loads, scheduled synchronization, and event replay. CleverTap also supports webhook-style outbound delivery for selected engagement and campaign use cases, although this is not a universal change-notification stream. Server-side authentication uses an account ID and passcode in request headers, with credentials and the regional API host stored securely in Martini environment configuration. Martini can consume these APIs, receive supported callbacks, map and validate payloads, schedule synchronization, and route failures for retry or review.
Common CleverTap integration patterns
Common CleverTap data objects used in integrations
Authentication and security considerations
Account credentials and regional endpoints
CleverTap server-side REST APIs generally use an account ID and passcode in X-CleverTap-Account-Id and X-CleverTap-Passcode headers. Requests must use the regional API host assigned to the CleverTap account rather than assuming a default region.
Secure configuration
Store the CleverTap account ID, passcode, and regional base URL in Martini environment configuration or secrets management. Do not embed credentials in workflow definitions, mappings, or source payloads.
Callback protection
For supported CleverTap webhook-style notifications, verify the authentication or signing behavior required by the specific feature, validate the payload, restrict the exposed endpoint where possible, and apply duplicate-event protection.
Operational considerations for CleverTap integrations
Throughput and batching
Confirm account and endpoint limits before designing high-volume ingestion. Use CleverTap batch upload APIs where applicable, split requests according to documented limits, throttle concurrency, and retry transient HTTP failures.
Pagination and checkpoints
Read and reporting APIs may use endpoint-specific pagination, cursors, date windows, or export identifiers. Persist a high-water mark and do not assume that every CleverTap endpoint uses the same retrieval model.
Identity and idempotency
Use stable identity fields to avoid unintended duplicate User Profiles. Apply source event IDs, deterministic keys, processing tables, or other deduplication logic when retries could repeat purchases, conversions, or callbacks.
Schema and side effects
Maintain controlled event names, property types, required fields, and versioning rules. Test changes in a controlled CleverTap environment because profile and event submissions may affect Segments, Campaigns, and Journeys.
Error handling and monitoring
Distinguish authentication, malformed payload, unsupported property, rate-limit, partial batch, and temporary service errors. Martini workflows can log outcomes, route data-quality failures for review, retry eligible failures, and persist reconciliation results.
Why use Martini instead of scripts or point-to-point integrations?
Orchestrated integration logic
Scripts and point-to-point calls often duplicate authentication, mapping, retry, and checkpoint logic. Martini centralizes these concerns in workflows that can receive events, call CleverTap, transform data, apply business rules, and write to multiple targets.
Reusable and governed APIs
Martini can expose a controlled API façade over CleverTap operations, allowing internal applications to use consistent contracts without embedding CleverTap regional endpoints and credentials throughout the estate.
Reliable synchronization
Batching, scheduling, idempotency, checkpointing, validation, and error routing can be designed as explicit workflow behavior. This supports repeatable profile and event synchronization and makes operational failures easier to diagnose than scattered scripts.
Flexible enterprise connectivity
Martini can combine CleverTap REST and callback integration with databases, files, messaging systems, and other APIs, allowing customer engagement data to participate in broader enterprise processes without requiring direct database access to CleverTap.