> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Iterable

> How to set up the Iterable connector, plus the actions and events that are available.

![Iterable](https://stackone-logos.com/api/iterable/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/iterable/changelog.md)

[68 actions](#actions) · [36 events](#events) · 1 auth method

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/iterable/guides/connector-profile/api-key.md)
>
> You need an Iterable account with permissions to create API keys. Generate a server-side API key in the Iterable web app...

Optionally, configure receiving Events for Iterable into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/iterable/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/iterable/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

68 actions

ActionDescription

List Campaign Metadata`iterable_list_campaigns`

List campaign metadata

Get A Campaign`iterable_get_campaign`

Get a campaign

Create A Campaign`iterable_create_campaign`

Create a campaign

Archive Campaigns`iterable_archive_campaigns`

Archive campaigns

Get The Catalog Items For A Catalog`iterable_list_catalog_items`

Get the catalog items for a catalog

Get Catalog Names`iterable_list_catalogs`

Get catalog names

Get A Specific Catalog Item`iterable_get_catalog_item`

Get a specific catalog item

Get Field Mappings For A Catalog`iterable_get_field_mappings`

Get field mappings for a catalog

Create A Catalog`iterable_create_catalog`

Create a catalog

Bulk Create Or Update Catalog Items`iterable_bulk_update_catalog_items`

Bulk create or update catalog items

Set A Catalog's Field Mappings (data Types)`iterable_update_field_types`

Set a catalog's field mappings (data types)

Bulk Delete Catalog Items`iterable_bulk_delete_catalog_items`

Bulk delete catalog items

Delete A Catalog`iterable_delete_catalog`

Delete a catalog

Delete A Catalog Item`iterable_delete_catalog_item`

Delete a catalog item

Create Or Replace A Catalog Item`iterable_index_catalog_item`

Create or replace a catalog item

Create Or Update A Catalog Item`iterable_partial_update_catalog_item`

Create or update a catalog item

Update A User's Shopping Cart Items`iterable_update_cart`

Update a user's shopping cart items

Track A Purchase`iterable_track_purchase`

Track a purchase

Send An Email To An Email Address`iterable_send_email`

Send an email to an email address

Get An Email Template By TemplateId`iterable_get_email_template`

Get an email template by templateId

Update Email Template`iterable_update_email_template`

Update email template

Create Email Template`iterable_upsert_email_template`

Create email template

Track An Event`iterable_track_event`

Track an event (requires either email or userId)

Get Export Job Files`iterable_get_export_files`

Get the downloadable files for an export job

Get Export Jobs`iterable_get_export_jobs`

Get export jobs

Cancel Export Job`iterable_cancel_export`

Stop a queued or running export job by jobId

Export Data To CSV`iterable_export_data_csv`

Export data to CSV (response is raw text/csv, not JSON)

Export Data To JSON`iterable_export_data_json`

Export data to JSON (response is raw NDJSON text, not a JSON object)

Export User Events`iterable_export_user_events`

Export user events

Start Export`iterable_start_export`

Start export

Send An In-app Notification To A User`iterable_send_in_app`

Send an in-app notification to a user (requires a Running In-App campaign)

Get Count Of Users In List`iterable_get_list_count`

Get count of users in list

Get Lists`iterable_get_lists`

Get lists

Get Users In A List`iterable_get_users`

Get users in a list (returns NDJSON text)

Preview Users In A List`iterable_get_users_preview`

Preview users in a list (returns CSV text)

Create A Static List`iterable_create_list`

Create a static list

Delete A List`iterable_delete_list`

Delete a list

Add Subscribers To List`iterable_subscribe_users_to_list`

Add subscribers to list

Remove Users From A List`iterable_unsubscribe_users_from_list`

Remove users from a list

Send Push Notification To User`iterable_send_push`

Send push notification to user

Send SMS Notification To User`iterable_send_sms`

Send SMS notification to user

Bulk Subscription Action On A List Of Users`iterable_bulk_subscription_action`

Bulk subscription action on a list of users

Subscribe A Single User`iterable_subscribe_single_user`

Subscribe a single user

Subscribe A Single User By Their UserId`iterable_subscribe_single_user_by_user_id`

Subscribe a single user by their userId

Unsubscribe A Single User`iterable_unsubscribe_single_user`

Unsubscribe a single user

Unsubscribe A Single User By UserId`iterable_unsubscribe_single_user_by_user_id`

Unsubscribe a single user by userId

Get An Email Template By ClientTemplateId`iterable_get_by_client_template_id`

Get an email template by clientTemplateId

Get Project Templates`iterable_get_templates`

Get project templates

Bulk Delete Templates`iterable_bulk_delete_templates`

Bulk delete templates

Get Messages Sent To A User`iterable_get_sent_messages`

Get messages sent to a user (one of email or userId is required)

Get A User By Email (query Parameter)`iterable_get_user`

Get a user by email (query parameter)

Get A User By Email (path Parameter)`iterable_get_user_by_email`

Get a user by email (path parameter)

Get A User By UserId (query Parameter)`iterable_get_user_by_id`

Get a user by userId (query parameter)

Get A User By UserId (path Parameter)`iterable_get_user_by_user_id_path`

Get a user by userId (path parameter)

Get All User Fields`iterable_get_user_fields`

Get all user fields

Bulk Update User Subscriptions`iterable_bulk_update_subscriptions`

Bulk update user subscriptions

Bulk Update User Data`iterable_bulk_update_user`

Bulk update user data

Update User Email`iterable_update_email`

Update user email

Update User Subscriptions`iterable_update_subscriptions`

Update user subscriptions

Update User Data`iterable_update_user`

Update user data

Delete A User By Email`iterable_delete_user_by_email`

Delete a user by email (asynchronous)

Delete User By UserId`iterable_delete_user_by_user_id`

Delete user by userId

Get Hashed Forgotten Users In Compliance With GDPR`iterable_export_project_forgotten_users`

Get hashed forgotten users in compliance with GDPR

Forget A User In Compliance With GDPR`iterable_forget`

Forget a user in compliance with GDPR

Merge Users`iterable_merge_users`

Merge users

Unforget A User In Compliance With GDPR`iterable_unforget`

Unforget a user in compliance with GDPR

Get Journeys (workflows)`iterable_get_journeys`

Get journeys (workflows)

Trigger A Journey (workflow)`iterable_trigger_workflow`

Trigger a journey (workflow)

## Events

Tags

Select all
|
Clear

Emails

Embedded Messages

In-App Messages

Push Notifications

SMS

Sessions

Web Push Notifications

Webhooks

Workflows

No tags found

36 events

EventDescriptionTags

Email Send`iterable_webhook_email_send`

Fired when an email is sent to a user (emailSend).

EmailsWebhooks

Email Open`iterable_webhook_email_open`

Fired when a user opens an email (emailOpen).

EmailsWebhooks

Email Click`iterable_webhook_email_click`

Fired when a user clicks a link in an email (emailClick).

EmailsWebhooks

Email Bounce`iterable_webhook_email_bounce`

Fired when an email bounces (hard or soft) (emailBounce).

EmailsWebhooks

Email Complaint`iterable_webhook_email_complaint`

Fired when a user marks an email as spam (files a complaint) (emailComplaint).

EmailsWebhooks

Email Send Skip`iterable_webhook_email_send_skip`

Fired when an email send is skipped (e.g. suppression list, quiet hours, frequency cap) (emailSendSkip).

EmailsWebhooks

Email Subscribe`iterable_webhook_email_subscribe`

Fired when a user subscribes to a message type or channel (emailSubscribe).

EmailsWebhooks

Email Unsubscribe`iterable_webhook_email_un_subscribe`

Fired when a user unsubscribes from a message type or channel (emailUnSubscribe).

EmailsWebhooks

Hosted Unsubscribe Click`iterable_webhook_hosted_unsubscribe_click`

Fired when a user clicks a hosted (one-click) unsubscribe link (hostedUnsubscribeClick).

EmailsWebhooks

SMS Send`iterable_webhook_sms_send`

Fired when an SMS message is sent to a user (smsSend).

SMSWebhooks

SMS Received`iterable_webhook_sms_received`

Fired when an inbound SMS message is received from a user (smsReceived).

SMSWebhooks

SMS Bounce`iterable_webhook_sms_bounce`

Fired when an SMS message fails to be delivered (bounces) (smsBounce).

SMSWebhooks

SMS Click`iterable_webhook_sms_click`

Fired when a user clicks a link in an SMS message (smsClick).

SMSWebhooks

SMS Send Skip`iterable_webhook_sms_send_skip`

Fired when an SMS send is skipped (e.g. suppression, invalid number, frequency cap) (smsSendSkip).

SMSWebhooks

Push Send`iterable_webhook_push_send`

Fired when a push notification is sent to a user device (pushSend).

Push NotificationsWebhooks

Push Open`iterable_webhook_push_open`

Fired when a user opens a push notification (pushOpen).

Push NotificationsWebhooks

Push Bounce`iterable_webhook_push_bounce`

Fired when a push notification fails to be delivered (e.g. invalid device token) (pushBounce).

Push NotificationsWebhooks

Push Send Skip`iterable_webhook_push_send_skip`

Fired when a push send is skipped (e.g. no device token, suppression, frequency cap) (pushSendSkip).

Push NotificationsWebhooks

Push Uninstall`iterable_webhook_push_uninstall`

Fired when the app is detected as uninstalled via push-token invalidation (pushUninstall).

Push NotificationsWebhooks

In-App Send`iterable_webhook_in_app_send`

Fired when an in-app message is sent to a user (inAppSend).

In-App MessagesWebhooks

In-App Open`iterable_webhook_in_app_open`

Fired when a user opens an in-app message (inAppOpen).

In-App MessagesWebhooks

In-App Click`iterable_webhook_in_app_click`

Fired when a user clicks a button or link in an in-app message (inAppClick).

In-App MessagesWebhooks

In-App Close`iterable_webhook_in_app_close`

Fired when a user dismisses or closes an in-app message (inAppClose).

In-App MessagesWebhooks

In-App Delivery`iterable_webhook_in_app_delivery`

Fired when an in-app message is delivered to a user device (inAppDelivery).

In-App MessagesWebhooks

In-App Delete`iterable_webhook_in_app_delete`

Fired when an in-app message is deleted from a user inbox (inAppDelete).

In-App MessagesWebhooks

In-App Recall`iterable_webhook_in_app_recall`

Fired when an in-app message is recalled (withdrawn) for a user (inAppRecall).

In-App MessagesWebhooks

In-App Send Skip`iterable_webhook_in_app_send_skip`

Fired when an in-app send is skipped (e.g. suppression, frequency cap) (inAppSendSkip).

In-App MessagesWebhooks

Embedded Click`iterable_webhook_embedded_click`

Fired when a user clicks an embedded message (embeddedClick).

Embedded MessagesWebhooks

Embedded Impression`iterable_webhook_embedded_impression`

Fired when an embedded message is shown to a user (impression) (embeddedImpression).

Embedded MessagesWebhooks

Embedded Received`iterable_webhook_embedded_received`

Fired when an embedded message is received by the client (embeddedReceived).

Embedded MessagesWebhooks

Embedded Session`iterable_webhook_embedded_session`

Fired when an embedded message session is recorded for a user (embeddedSession).

Embedded MessagesWebhooks

Web Push Send`iterable_webhook_web_push_send`

Fired when a web push notification is sent to a user (webPushSend).

Web Push NotificationsWebhooks

Web Push Click`iterable_webhook_web_push_click`

Fired when a user clicks a web push notification (webPushClick).

Web Push NotificationsWebhooks

Web Push Send Skip`iterable_webhook_web_push_send_skip`

Fired when a web push send is skipped (e.g. suppression, no subscription, frequency cap) (webPushSendSkip).

Web Push NotificationsWebhooks

Journey Exit`iterable_webhook_journey_exit`

Fired when a user exits a journey (workflow); the payload carries workflowId and exitReason (journeyExit).

WorkflowsWebhooks

Unknown Session`iterable_webhook_unknown_session`

Fired when anonymous (unknown) user sessions are attributed to a known user (unknownSession).

SessionsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.