API Reference

Enrich Pixel With Offline Events

post
https://api.triplewhale.com/api/v2/data-in/event

Send offline or server-side Pixel events—such as leads, MQLs, SQLs, opportunities, book-a-demo events, or fully custom events—into Triple Whale. Rate limit is 1,000 events/min. Max payload is 3 KB. When type = custom, you can add additional properties of type Number, Float, String, Boolean, or Date.

Body Params
string
required

The exact Shop URL (e.g., 'example.myshopify.com'). Must match the Shop URL value shown in Settings → Store. The API key owner must also have access to the shop, otherwise the request will return 403.

string
enum
required

The event category. Can be a standard lifecycle event (lead, mql, sql, opportunity, book_demo) or a Custom event (custom).

Allowed:
profileIdentifiers
object
required

At least one identifier is required. Use these to match the event to an existing or future profile.

string

Optional unique identifier for the event to prevent duplicates.

number

Optional UNIX timestamp in seconds for when the event occurred. Defaults to the current server time if omitted.

string

Required only when type = custom. A descriptive name for the custom event.

string

Optional attribution source for custom events. To have events grouped into existing paid channels in Attribution, use a standardized source ID (e.g. facebook-ads). Custom values will appear as separate custom sources.

string

Optional attribution campaign for custom events.

string

Optional attribution ad name for custom events.

string

Optional attribution ad set name for custom events.

Responses

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago