Skip to main content
Iterable
Iterable
68 actions · 36 events · 1 auth method
PreviewMarketingCampaignsMessagingCatalogsCommerceTrackingEmailTemplatesContentEventsAnalyticsAudienceSegmentationSmsSubscriptionsUsersAutomation

Authentication

API Key

You need an Iterable account with permissions to create API keys. Generate a server-side API key in the Iterable web app…Guides: Connector Profile, Link Account
Actions
68 actions
Action
Description
List Campaign Metadata
List campaign metadata
Get A Campaign
Get a campaign
Create A Campaign
Create a campaign
Archive Campaigns
Archive campaigns
Get The Catalog Items For A Catalog
Get the catalog items for a catalog
Get Catalog Names
Get catalog names
Get A Specific Catalog Item
Get a specific catalog item
Get Field Mappings For A Catalog
Get field mappings for a catalog
Create A Catalog
Create a catalog
Bulk Create Or Update Catalog Items
Bulk create or update catalog items
Set A Catalog’s Field Mappings (data Types)
Set a catalog’s field mappings (data types)
Bulk Delete Catalog Items
Bulk delete catalog items
Delete A Catalog
Delete a catalog
Delete A Catalog Item
Delete a catalog item
Create Or Replace A Catalog Item
Create or replace a catalog item
Create Or Update A Catalog Item
Create or update a catalog item
Update A User’s Shopping Cart Items
Update a user’s shopping cart items
Track A Purchase
Track a purchase
Send An Email To An Email Address
Send an email to an email address
Get An Email Template By TemplateId
Get an email template by templateId
Update Email Template
Update email template
Create Email Template
Create email template
Track An Event
Track an event (requires either email or userId)
Get Export Job Files
Get the downloadable files for an export job
Get Export Jobs
Get export jobs
Cancel Export Job
Stop a queued or running export job by jobId
Export Data To CSV
Export data to CSV (response is raw text/csv, not JSON)
Export Data To JSON
Export data to JSON (response is raw NDJSON text, not a JSON object)
Export User Events
Export user events
Start Export
Start export
Send An In-app Notification To A User
Send an in-app notification to a user (requires a Running In-App campaign)
Get Count Of Users In List
Get count of users in list
Get Lists
Get lists
Get Users In A List
Get users in a list (returns NDJSON text)
Preview Users In A List
Preview users in a list (returns CSV text)
Create A Static List
Create a static list
Delete A List
Delete a list
Add Subscribers To List
Add subscribers to list
Remove Users From A List
Remove users from a list
Send Push Notification To User
Send push notification to user
Send SMS Notification To User
Send SMS notification to user
Bulk Subscription Action On A List Of Users
Bulk subscription action on a list of users
Subscribe A Single User
Subscribe a single user
Subscribe A Single User By Their UserId
Subscribe a single user by their userId
Unsubscribe A Single User
Unsubscribe a single user
Unsubscribe A Single User By UserId
Unsubscribe a single user by userId
Get An Email Template By ClientTemplateId
Get an email template by clientTemplateId
Get Project Templates
Get project templates
Bulk Delete Templates
Bulk delete templates
Get Messages Sent To A User
Get messages sent to a user (one of email or userId is required)
Get A User By Email (query Parameter)
Get a user by email (query parameter)
Get A User By Email (path Parameter)
Get a user by email (path parameter)
Get A User By UserId (query Parameter)
Get a user by userId (query parameter)
Get A User By UserId (path Parameter)
Get a user by userId (path parameter)
Get All User Fields
Get all user fields
Bulk Update User Subscriptions
Bulk update user subscriptions
Bulk Update User Data
Bulk update user data
Update User Email
Update user email
Update User Subscriptions
Update user subscriptions
Update User Data
Update user data
Delete A User By Email
Delete a user by email (asynchronous)
Delete User By UserId
Delete user by userId
Get Hashed Forgotten Users In Compliance With GDPR
Get hashed forgotten users in compliance with GDPR
Forget A User In Compliance With GDPR
Forget a user in compliance with GDPR
Merge Users
Merge users
Unforget A User In Compliance With GDPR
Unforget a user in compliance with GDPR
Get Journeys (workflows)
Get journeys (workflows)
Trigger A Journey (workflow)
Trigger a journey (workflow)
Events
|
36 events
Event
Description
Tags
Email Send
Fired when an email is sent to a user (emailSend).
Email
Email Open
Fired when a user opens an email (emailOpen).
Email
Email Click
Fired when a user clicks a link in an email (emailClick).
Email
Email Bounce
Fired when an email bounces (hard or soft) (emailBounce).
Email
Email Complaint
Fired when a user marks an email as spam (files a complaint) (emailComplaint).
Email
Email Send Skip
Fired when an email send is skipped (e.g. suppression list, quiet hours, frequency cap) (emailSendSkip).
Email
Email Subscribe
Fired when a user subscribes to a message type or channel (emailSubscribe).
Email
Email Unsubscribe
Fired when a user unsubscribes from a message type or channel (emailUnSubscribe).
Email
Hosted Unsubscribe Click
Fired when a user clicks a hosted (one-click) unsubscribe link (hostedUnsubscribeClick).
Email
SMS Send
Fired when an SMS message is sent to a user (smsSend).
SMS
SMS Received
Fired when an inbound SMS message is received from a user (smsReceived).
SMS
SMS Bounce
Fired when an SMS message fails to be delivered (bounces) (smsBounce).
SMS
SMS Click
Fired when a user clicks a link in an SMS message (smsClick).
SMS
SMS Send Skip
Fired when an SMS send is skipped (e.g. suppression, invalid number, frequency cap) (smsSendSkip).
SMS
Push Send
Fired when a push notification is sent to a user device (pushSend).
Push
Push Open
Fired when a user opens a push notification (pushOpen).
Push
Push Bounce
Fired when a push notification fails to be delivered (e.g. invalid device token) (pushBounce).
Push
Push Send Skip
Fired when a push send is skipped (e.g. no device token, suppression, frequency cap) (pushSendSkip).
Push
Push Uninstall
Fired when the app is detected as uninstalled via push-token invalidation (pushUninstall).
Push
In-App Send
Fired when an in-app message is sent to a user (inAppSend).
In-App
In-App Open
Fired when a user opens an in-app message (inAppOpen).
In-App
In-App Click
Fired when a user clicks a button or link in an in-app message (inAppClick).
In-App
In-App Close
Fired when a user dismisses or closes an in-app message (inAppClose).
In-App
In-App Delivery
Fired when an in-app message is delivered to a user device (inAppDelivery).
In-App
In-App Delete
Fired when an in-app message is deleted from a user inbox (inAppDelete).
In-App
In-App Recall
Fired when an in-app message is recalled (withdrawn) for a user (inAppRecall).
In-App
In-App Send Skip
Fired when an in-app send is skipped (e.g. suppression, frequency cap) (inAppSendSkip).
In-App
Embedded Click
Fired when a user clicks an embedded message (embeddedClick).
Embedded
Embedded Impression
Fired when an embedded message is shown to a user (impression) (embeddedImpression).
Embedded
Embedded Received
Fired when an embedded message is received by the client (embeddedReceived).
Embedded
Embedded Session
Fired when an embedded message session is recorded for a user (embeddedSession).
Embedded
Web Push Send
Fired when a web push notification is sent to a user (webPushSend).
Web Push
Web Push Click
Fired when a user clicks a web push notification (webPushClick).
Web Push
Web Push Send Skip
Fired when a web push send is skipped (e.g. suppression, no subscription, frequency cap) (webPushSendSkip).
Web Push
Journey Exit
Fired when a user exits a journey (workflow); the payload carries workflowId and exitReason (journeyExit).
Other
Unknown Session
Fired when anonymous (unknown) user sessions are attributed to a known user (unknownSession).
Other

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.

Connector Profile

Iterable - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.

Link Account

Iterable - API Key
4

Use Actions

Invoke actions using one of the methods below:
  • MCP – Model Context Protocol for AI assistants
  • A2A – Agent-to-Agent protocol
  • Agent SDK – TypeScript and Python SDKs for AI agents
  • Actions RPC – Direct API calls
  • Playground – Test actions in the dashboard

Webhook Events

Webhooks setup

Configure receiving Events for Iterable into StackOne.