---
title: "Iterable Webhook"
method: POST
path: "/iterable/webhook"
tags: ["Webhooks - Iterable"]
---

# Iterable Webhook

`POST /iterable/webhook`

## Request

- Base URL: `https://api.puppeteerai.com`
- URL: `https://api.puppeteerai.com/iterable/webhook`
- Auth: none declared. Required headers: `X-Iterable-Webhook-Secret`

Receives Iterable system webhook events (smsSend, smsReceived).

Identifies the project via the explicit `project_id` query param and validates the
request against the per-project IterableAccountModel.webhook_secret.

## Query parameters

- `project_id` string, required

## Headers

- `X-Iterable-Webhook-Secret` string, required

## Request body

- IterableWebhookPayload
  - `email` string, required
  - `eventName` 'smsSend' | 'smsReceived', required
  - `campaignId` integer, nullable
  - `dataFields` IterableDataFields: Subset of Iterable's webhook dataFields we care about. Iterable may add fields without notice.
    - `smsMessage` string, nullable
    - `fromPhoneNumber` string, nullable
    - `toPhoneNumber` string, nullable
    - `espName` string, nullable
    - `createdAt` string, nullable
    - `campaignId` integer, nullable
    - `transactionalData` string, nullable
    - `esDocumentId` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getpuppeteer/apis/puppeteer-core-api.md) - [All operations](https://skmtc.dev/getpuppeteer/apis/puppeteer-core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getpuppeteer/apis/puppeteer-core-api/revisions/94b4e928b42f?raw)