How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Iterable

Iterable Events API

Track custom events, retrieve event data for users, and manage event metadata used for segmentation and campaign triggering.

Documentation Provider Profile APIs.io OpenAPI GitHub

Iterable Events API is one of 30 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 17 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.iterable.com/, https://api.iterable.com/api, https://api.eu.iterable.com/api.

17 operations 17 paths 24 schemas 3 GET14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.iterable.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Iterable Events API declares 2 security schemes for authenticating requests. An API key is passed in the header as Api-Key (api_key). An API key is passed in the header as Api-Key (apiKeyAuth).

  • apiKeyAuth — Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 3 GET, 14 POST. Each is listed below with its method, path, parameters, and response codes.

events 17
POST
/api/embedded-messaging/events/click
Track an embedded message click
embedded-track-click body → 400401
POST
/api/embedded-messaging/events/received
Track an embedded message received event
embedded-track-received body → 400401
POST
/api/embedded-messaging/events/session
Track an embedded message session and related impressions
embedded-track-impression body → 400401
GET
/api/events/byUserId/{userId}
Get user events by userId
User events by userId 2 params → 200400401
POST
/api/events/inAppConsume
Consume or delete an in-app message
inAppConsume body → 200400401
POST
/api/events/track
Track an event
track body → 200400401
POST
/api/events/trackBulk
Bulk track events
trackBulk body → 200400401
POST
/api/events/trackInAppClick
Track an in-app message click
trackInAppClick body → 200400401
POST
/api/events/trackInAppClose
Track the closing of an in-app message
trackInAppClose body → 200400401
POST
/api/events/trackInAppDelivery
Track the delivery of an in-app message
trackInAppDelivery body → 200400401
POST
/api/events/trackInAppOpen
Track an in-app message open
trackInAppOpen body → 200400401
POST
/api/events/trackPushOpen
Track a mobile push open
trackPushOpen body → 200400401
POST
/api/events/trackWebPushClick
Track a web push click
trackWebPushClick body → 200400401
GET
/api/events/{email}
Get user events
User events 2 params → 200400401
POST
/events/track
Track a custom event
trackEvent body → 200400401
POST
/events/trackBulk
Track multiple events in bulk
trackBulkEvents body → 200400401
GET
/events/{email}
Get events for a user by email
getEventsByEmail 2 params → 200401404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are InAppCloseRequest (9 properties), TrackRequest (9 properties), BulkTrackResponse (8 properties), EmbeddedClickRequest (7 properties). Each schema is shown below with its type and property counts.

InAppDeliveryRequest
object
6 properties 1 required
TrackPushOpenRequest
object
7 properties 2 required
EmbeddedReceivedRequest
object
5 properties 1 required
BulkTrackResponse
object
8 properties 2 required
EmbeddedClickRequest
object
7 properties 1 required
BulkTrackRequest
object
1 property 1 required
EmbeddedSessionRequest
object
6 properties
InAppCloseRequest
object
9 properties 1 required
InAppConsumeRequest
object
7 properties 1 required
EmbeddedSession
object
3 properties
TrackRequest
object
9 properties 1 required
GetEventsResponse
object
1 property 1 required
IterableApiResponse
object
3 properties 2 required
InAppClickRequest
object
7 properties 1 required
Impression
object
4 properties
MessageContext
object
2 properties
FailedEventUpdates
object
6 properties
DeviceInfo
object
3 properties 3 required
WebPushClickEventRequest
object
6 properties 1 required
InAppOpenRequest
object
6 properties 1 required
InboxMessageContext
object
3 properties
Event
object
An event tracked for a user
5 properties
TrackEventRequest
object
Request body for tracking a custom event
7 properties 2 required
IterableResponse
object
Standard Iterable API response indicating success or failure
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-events-api-openapi.yml Raw ↑

Other APIs Iterable publishes across the network.

Iterable Export API
AE Profile APIs.io
Iterable Web SDK
AE Profile APIs.io
Iterable iOS SDK
AE Profile APIs.io
Iterable Android SDK
AE Profile APIs.io
Iterable React Native SDK
AE Profile APIs.io
Iterable Campaigns API
AE Profile APIs.io
Iterable Catalogs API
AE Profile APIs.io
Iterable Channels API
AE Profile APIs.io
Iterable Commerce API
AE Profile APIs.io
Iterable Email API
AE Profile APIs.io
Iterable Experiments API
AE Profile APIs.io
Iterable InApp API
AE Profile APIs.io
#Event
← Back to I APIs
API Details
ID
iterable:iterable-events-api
Base URL
https://api.iterable.com
Docs
https://api.iterable.com/api/docs
Provider
Iterable
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=iterable-events-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/iterable-events-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Iterable Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.