CleverTap API

Name: CleverTap API
Brand: CleverTap API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingMarketing AutomationapiKey20 EndpointsREST

For Agents

Drive CleverTap server-side workflows — upload profiles and events, manage identities, and create or stop targeted messaging campaigns across mobile and web.

Install Jentic One Beta

Connect the CleverTap API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CleverTap API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with CleverTap API.

Ingest user profiles and events in bulk through the upload endpoint

Resolve and manage user identity, including merging and demerging profile records

Create, stop, and read the result of targeted push, email, SMS, web, and in-app campaigns

GET STARTED

Start building with CleverTap API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for CleverTap API, keeping it validated and agent-ready. The CleverTap server-side API powers customer engagement workflows for the CleverTap product analytics and messaging platform, covering profile uploads, identity merging, event ingestion, campaign target management, and reporting. Authentication uses paired X-CleverTap-Account-Id and X-CleverTap-Passcode headers, and the API is regionally hosted across US, India, Europe, and Singapore endpoints. Agents can use it to ingest events, manage subscriber profiles, and create or stop targeted push, email, and in-app campaigns.

Use Cases

Patterns agents use CleverTap API for, with concrete tasks.

★ Server-Side Event and Profile Ingestion

Forward user events and profile updates from a backend system to CleverTap so that segmentation, campaigns, and analytics stay in sync with the source-of-truth user data. The /1/upload endpoint accepts batched events and profile updates in a single payload, which keeps ingestion efficient. A typical ingestion job takes a day or two to wire up, including identity resolution rules.

Send a /1/upload payload containing one profile update and three events for identity 'user_1234' and verify the response reports zero errors

Triggered Campaign Orchestration

Create and manage CleverTap target campaigns from an external orchestrator — for example releasing a push or email campaign when a customer hits a specific lifecycle stage. The /1/targets/create.json, /stop.json, and /result.json endpoints provide the full lifecycle, and /1/message/report.json returns engagement data for follow-up. Wiring this in takes a few hours per channel.

Create a push campaign for segment 'cart_abandoners' via /1/targets/create.json and poll /1/targets/result.json until delivery completes

Product Analytics Queries

Query CleverTap for event counts, trends, and top events to power an internal dashboard or to feed downstream BI. The /1/counts/events.json, /counts/top.json, and /counts/trends.json endpoints return aggregated metrics over a chosen window, suitable for daily reporting jobs. Setup is typically under a day.

Call /1/counts/events.json for event 'purchase' over the last 30 days and return the daily count series

Agent-Driven Engagement Operations via Jentic

Expose CleverTap to an AI agent through Jentic so a marketing operator can describe an outcome — 'send a push to cart abandoners with a 10 percent code' — and have the agent compose the right /1/targets/create.json call. Jentic isolates the account passcode and surfaces only the operations relevant to the intent. A working integration takes well under an hour.

Search Jentic for 'create a clevertap push campaign', load the schema for /1/targets/create.json, and execute it for segment 'cart_abandoners'

Key Endpoints

20 endpoints — jentic publishes the only available openapi specification for clevertap api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/1/upload

Bulk upload events and profile updates

POST

/1/targets/create.json

Create a target campaign

POST

/1/targets/stop.json

Stop a target campaign

POST

/1/targets/result.json

Get results for a target campaign

POST

/1/counts/events.json

Query event counts over a time window

POST

/1/counts/trends.json

Query event trends over time

POST

/1/upload

Bulk upload events and profile updates

POST

/1/targets/create.json

Create a target campaign

POST

/1/targets/stop.json

Stop a target campaign

POST

/1/targets/result.json

Get results for a target campaign

POST

/1/counts/events.json

Query event counts over a time window

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

CleverTap account id and passcode header pairs are stored encrypted in the Jentic vault. Agents receive scoped execution handles — the passcode never enters the agent context, so a compromised agent cannot exfiltrate the credential.

Intent-based discovery

Agents search by intent (e.g., 'create a clevertap push campaign') and Jentic returns the matching CleverTap operation with its input schema, so the agent calls the right endpoint without browsing the 20-endpoint reference.

Time to first call

Direct CleverTap integration: 1-2 days for region selection, header auth, event payload shaping, and campaign lifecycle. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using CleverTap API through Jentic.

Why is there no official OpenAPI spec for CleverTap API?

CleverTap does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CleverTap API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the CleverTap API use?

CleverTap uses paired API key headers — X-CleverTap-Account-Id and X-CleverTap-Passcode — on every request. When called through Jentic, the passcode is held in the Jentic vault and only the account id is visible to the agent context.

Which CleverTap region should I call?

CleverTap exposes regional base URLs: api.clevertap.com (US), in1.api.clevertap.com (India), eu1.api.clevertap.com (Europe), and sg1.api.clevertap.com (Singapore). Use the region your account was provisioned in — calls to the wrong region return 401.

Can I trigger a push campaign with the CleverTap API?

Yes. /1/targets/create.json accepts a target definition that includes channel (push, email, SMS, web, in-app), segment, and message payload. Pair with /1/targets/result.json to read delivery and engagement counters for that campaign.

What are the rate limits for the CleverTap API?

CleverTap does not document fixed numeric rate limits in the public spec. In practice, /1/upload supports large batches (up to a few MB) and is preferred over many small calls; campaign create endpoints are subject to plan-level concurrency limits.

How do I send events to CleverTap through Jentic?

Run pip install jentic, search for 'upload events to clevertap', load the operation against /1/upload, and execute it with the events payload. Jentic injects the X-CleverTap-Account-Id and X-CleverTap-Passcode headers from the vault.

CleverTap API

Connect the CleverTap API to your agent

Capabilities

Start building with CleverTap API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs