Create or update custom customer event

Enrich customer profiles with additional events that represent customer actions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The store ID (app_key).

Body Params
string

The source of the event. This should indicate the third-party tool sending the event in “snake-cased” format. Max length of the string is 255. String cannot be empty.

string
required

The type of event. This name should be “snake-cased”, i.e . "order_shipped”". Max length of the string is 255. String cannot be empty.

date
required

Timestamp of when the action occurred in ISO 8601 format. If no timestamp is provided, it is assumed the event occurred when the endpoint is called.

string
required

A unique identifier representing this specific event - UUID is recommended. Overrides existing event when ID value already exists in our database

json
required

Identifiers and properties of the customer associated with this action. You must identify the customer by an external_id. If there isn’t an external_id that can be used - you must identify the customer by only one of the following identifiers: phone_number or email. If an external_id is not specified, we cannot accept both email and phone_number in the payload.

string

A unique customer identifier. This ID will be used to identify the customer in our database, it is used for creating profiles, attributing events to profiles, and merging profiles. If you don’t have a unique identifier for the customer, avoid using this property. If you’re using Shopify as your eCommerce platform, please use the Shopify customer ID.

string

Phone number of the customer associated with the action. E.164 format is required.

string

Email of the customer associated with the action.

json

Metadata associated with the customer is represented as a JSON object with < string key >:< primitive type value > pairs. Supported primitive types include string, boolean, int, long, double, and date (ISO). 'null' values are not supported. Property names must use underscores (_) instead of spaces. These properties can be used for segmentation or to personalize campaigns.

json

Any metadata associated with the event. JSON OBJECT of < string key >:< primitive type value >. The primitive type could be any of the following: string, boolean, int, long, float, double, and date (ISO). These properties can be used for segmentation or to personalize campaigns.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json