Iterable

Update user profiles and trigger cross-channel email/push/SMS campaign sends via the Iterable API.

Grounded in the Iterable API docs: https://api.iterable.com/api/docs

• Base URL: https://api.iterable.com
• Auth: a single server-side API key sent in the Api-Key request header. No OAuth/JWT exchange — pass the key directly as apiKey.

What it does

A thin, standard-library-only wrapper over five Iterable endpoints: read a user profile, upsert a user profile, and trigger a campaign send on any of the three channels (email, SMS, push) to a single recipient.

Operations

The three send-* operations are Iterable's "target" sends — they fire a campaign (campaignId, an integer) at a single recipient identified by email or userId, with optional dataFields merged into the template. This is the standard path for transactional / triggered campaigns.

Inputs

Outputs

• result — the Iterable response body as a JSON string.
• status — the HTTP status code as a string (e.g. "200").

API key setup

1. Sign in to https://app.iterable.com.
2. Go to Settings -> API Keys.
3. Create a Server-side key and copy it.
4. Pass that value as the apiKey input. It is sent verbatim in the Api-Key header on every request — no token exchange required.

Examples

Look up a user:

{
  "apiKey": "YOUR_SERVER_SIDE_KEY",
  "operation": "get-user",
  "email": "[email protected]"
}

Upsert profile fields:

{
  "apiKey": "YOUR_SERVER_SIDE_KEY",
  "operation": "update-user",
  "email": "[email protected]",
  "dataFields": "{\"firstName\":\"Jane\",\"plan\":\"pro\",\"signupSource\":\"hub\"}"
}

Trigger an email campaign to one recipient with template merge data:

{
  "apiKey": "YOUR_SERVER_SIDE_KEY",
  "operation": "send-email",
  "campaignId": "1234567",
  "email": "[email protected]",
  "dataFields": "{\"orderId\":\"A-9981\",\"total\":\"$42.00\"}"
}

Trigger an SMS or push campaign (same shape, different operation):

{
  "apiKey": "YOUR_SERVER_SIDE_KEY",
  "operation": "send-sms",
  "campaignId": "2233445",
  "userId": "user_8842"
}

Notes

• Standard library only (urllib, json) — no third-party packages.
• Response bodies are capped at ~5 MB.
• 4xx/5xx responses are returned (not raised): result carries Iterable's error JSON and status carries the code, so you can branch on failures in a job.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.