API

Customer Events API reference

Reference the Segment-compatible event routes, common fields, responses, and canonical compatibility endpoint.

Updated 2026-08-2310 min

Base URL and content type

All request bodies must be JSON and use Content-Type: application/json.

API base

Copy

Base URLNode.jsPython

https://www.attunemail.com/v1

Routes

Route	Purpose	Required fields
POST /track	Record customer behavior	event and one customer identifier
POST /identify	Update identity and traits	userId or anonymousId
POST /group	Associate company or account context	groupId and a customer identifier
POST /alias	Link a previous identifier to a new userId	previousId and userId
POST /page	Record deliberate server-side page activity	name or properties plus an identifier
POST /screen	Record deliberate server-side screen activity	name or properties plus an identifier
POST /batch	Send up to 500 mixed compatible messages	batch array

Common fields

Field	Meaning
messageId	Producer-generated idempotency key
userId	Durable customer ID
anonymousId	Pre-authentication customer ID
timestamp	Original event timestamp when supplied
context	Bounded source context
properties	Event-specific values
traits	Customer or group attributes

Successful response

A successful HTTP response confirms durable acceptance, not that a journey sent an email. Inspect processing state and journey enrollments separately.

Single or batch response

Copy

JSONNode.jsPython

{
  "success": true,
  "batchId": "018f...",
  "received": 2,
  "duplicates": 0
}

Canonical compatibility endpoint

Existing plain HTTP integrations can use POST /v1/events/{connection_id} with Bearer or X-AttuneMail-Webhook-Secret authentication. New integrations should normally choose the Segment-compatible routes or a native provider webhook.

Limits and idempotencyPlan request sizes, retry behavior, and throughput.