postproxy-dev · Schema

WhatsAppConversionEventRequest

Reports an outcome back to Meta for Click-to-WhatsApp ad optimization. Requires a chat whose ctwa_clid was captured, and a Conversions API dataset on the account.

Social MediaSoftware-as-a-ServiceMarketingAutomation

Properties

Name Type Description
event_name string
event_id string Your unique id for the event; Meta dedupes on it.
chat_id string The chat the customer arrived in. One of chat_id or phone is required.
phone string The customer’s phone number instead; the most recently active chat with it is used.
event_time object Unix seconds or ISO 8601. Defaults to now.
value number
currency string ISO 4217 code, e.g. USD.
content_ids array
email string SHA-256 hashed before it leaves Postproxy.
external_id string Your customer id. SHA-256 hashed before it leaves Postproxy.
test_code string Meta test event code, to see the event in Events Manager without affecting optimization.
dataset_id string Send to a specific dataset instead of the account’s own.
View JSON Schema on GitHub

JSON Schema

postproxy-dev-whats-app-conversion-event-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/postproxy-dev/json-schema/postproxy-dev-whats-app-conversion-event-request-schema.json",
  "title": "WhatsAppConversionEventRequest",
  "description": "Reports an outcome back to Meta for Click-to-WhatsApp ad optimization. Requires a chat whose ctwa_clid was captured, and a Conversions API dataset on the account.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postproxy-dev-whats-app-api-openapi.yml#/components/schemas/WhatsAppConversionEventRequest",
  "type": "object",
  "required": [
    "event_name",
    "event_id"
  ],
  "properties": {
    "event_name": {
      "type": "string",
      "enum": [
        "LeadSubmitted",
        "Purchase",
        "AddToCart",
        "InitiateCheckout",
        "ViewContent"
      ]
    },
    "event_id": {
      "type": "string",
      "description": "Your unique id for the event; Meta dedupes on it."
    },
    "chat_id": {
      "type": "string",
      "description": "The chat the customer arrived in. One of chat_id or phone is required."
    },
    "phone": {
      "type": "string",
      "description": "The customer’s phone number instead; the most recently active chat with it is used."
    },
    "event_time": {
      "description": "Unix seconds or ISO 8601. Defaults to now.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "value": {
      "type": "number"
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 code, e.g. USD."
    },
    "content_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "email": {
      "type": "string",
      "description": "SHA-256 hashed before it leaves Postproxy."
    },
    "external_id": {
      "type": "string",
      "description": "Your customer id. SHA-256 hashed before it leaves Postproxy."
    },
    "test_code": {
      "type": "string",
      "description": "Meta test event code, to see the event in Events Manager without affecting optimization."
    },
    "dataset_id": {
      "type": "string",
      "description": "Send to a specific dataset instead of the account’s own."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/postproxy-dev-whats-app-conversion-event-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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