Signal API (0.1)

Signals API Reference

By providing a fully documented API reference, we want to enable everyone to maximize the usage of the Interactive Moments platform

Authentication

The Marigold Signals V1 API's are using the basic authentication protocol, i.e. key/secret authentication, using the X-Api-Key Header and Value {key}:{secret}. If you have an Interactive Moments account you are able to create an audience configuration. In this audience configuration a key and secret will be automatically created for you to copy paste. The key is by default disabled. If you want to use that key & secret, press the enable button.

Automatically both SDK (public) & server api key (private) will be created and disabled. You can enable them by using the slider or generated a new one. There is no expiry date on it for now.

Errors

Marigold uses the conventional HTTP response codes to indicate successful or failed API requests.

Codes in the 2xx range indicate success.

Codes in the 4xx range indicate an input related error or validation restrictions.

Codes in the 5xx range indicate an error with Marigold Engage servers.

HTTP Status Codes	Description
200 - OK	We found the request resource
401 - Unauthorized	The access key was incorrect
5xx - Server errors	Something went wrong on our end. Please try again

OpenAPI specification

We provide the API specification in the format of OpenApi files which can be found in the openapi/ directory:

OpenAPI 3.0 - YAML format - signals-moments-api-rest-v1.openapi.yaml

User identification type

There are multiple ways to send a profile identifier to through our API stream,

The type of user identification is for you to define in the idType section. This could be Email, External, Phone, etc.

All possible enums for now: "external" "email", these will be available later -> "phone" "deviceId" "appId" "marketing". While the default is put on "email".

Examples:

1 - Email as default:

{
- "data": {
    "email": "john.doe@cheetahdigital.com",
}
}

2 - Email as default possibility with idType:

{
- "data": {
    "idType": "email",
    "email": "john.doe@cheetahdigital.com",
}
}

3 - CustomerId with idType "external"

{
- "data": {
     "idType": "external",
     "customerId": "123",
}
}
}

Authentication

Authentication for the API

Endpoint generates JWT token based on Basic Authentication header. The header has following structure: Authentication: Basic base64(<Private Key>:<Secret>) In this case Private Key is defined in the respective audience API same as Secret. Private Key needs to be enabled. Combination of the Private Key/Secret needs to be base64 encoded. The API returns in the response JWT token which needs to be used for the signal specific API calls with following header: Authentication: Bearer <JWT>

Authorizations:

basicAuth

Responses

Response Schema: application/json

jwt	string JSON which contains encoded JWT token

Response samples

200

Content type

application/json

{"jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkxMSIsImF1ZCI6InN0cmluZyIsInJvbGVzIjpbIlJPTEVfVVNFUiJdLCJpc3MiOiJhdGxhcyIsImN1c3RvbWVySWQiOiIxIiwiZXhwIjoxNzMwMTMyOTEzLCJpYXQiOjE3MzAxMjkzMTN9.gzn0ddO3nirDKcp8v7wpk8L86gbl7wF2k-d_mePW_eA"
}

Behavior signals

Booking Update Signal

Process Booking Update Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

bookingId required	string (Booking ID) Default: "" Booking identifier
bookingName required	string (Booking Name) Default: "" Booking name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"bookingId": "B128765",
"bookingName": "Hotel Booking #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Booking Start Signal

Process Booking Start Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

bookingId required	string (Booking ID) Default: "" Booking identifier
bookingName required	string (Booking Name) Default: "" Booking name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"bookingId": "B128765",
"bookingName": "Hotel Booking #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Category Browse Signal

Process Browse Category Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or site identifier
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
sections required	Array of strings (Sections) [ items ] Default: [] List of Sections
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"email": "john.doe@cheetahdigital.com",
"site": "www.example.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"sections": [["men",
"clothes",
"sport"
],
["brands",
"Infini"
]
]
}
}

Product Browse Signal

Process Product V Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or Site identifier
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
sections required	Array of strings (Sections) [ items ] Default: [] List of Sections
required	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "www.example.com",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"sections": [["men",
"clothes",
"sport"
],
["brands",
"Infini"
]
],
"elements": [{"type": "item",
"id": "345",
"name": "TV 50\" Very Good"
}
]
}
}

Configuration Complete Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

configurationId required	string (Configuration ID) Default: "" Configuration identifier
configurationName required	string (Configuration Name) Default: "" Configuration name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"configurationId": "car_sel_123",
"configurationName": "Car Selector #123",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"type": "item",
"id": "345",
"name": "Mercedes E-class AMG configg"
}
]
}
}

Configuration Start Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

configurationId required	string (Configuration ID) Default: "" Configuration identifier
configurationName required	string (Configuration Name) Default: "" Configuration name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"configurationId": "car_sel_123",
"configurationName": "Car Selector #123",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"type": "item",
"id": "345",
"name": "Mercedes E-class AMG configg"
}
]
}
}

Configuration Update Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

configurationId required	string (Configuration ID) Default: "" Configuration identifier
configurationName required	string (Configuration Name) Default: "" Configuration name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"configurationId": "car_sel_123",
"configurationName": "Car Selector #123",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"type": "item",
"id": "345",
"name": "Mercedes E-class AMG configg"
}
]
}
}

Game End Signal

Process Game End Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

gameId required	string (Game ID) Default: "" Game identifier
gameName required	string (Game Name) Default: "" Game name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"gameId": "G128765",
"gameName": "Game #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Game Start Signal

Process Game Start Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

gameId required	string (Game ID) Default: "" Game identifier
gameName required	string (Game Name) Default: "" Game name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"gameId": "G128765",
"gameName": "Game #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Game Update Signal

Process Game Update Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

gameId required	string (Game ID) Default: "" Game identifier
gameName required	string (Game Name) Default: "" Game name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"gameId": "G128765",
"gameName": "Game #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Site Signin Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "www.example.com",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Site Signout Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "www.example.com",
"profileName": "John Doe",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Survey Complete Signal

Processes Survey Complete Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

surveyId required	string (Survey ID) Default: "" Survey identifier
surveyName required	string (Survey Name) Default: "" Survey name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"surveyId": "S128765",
"surveyName": "Survey #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Survey Start Signal

Processes Survey Start Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

surveyId required	string (Survey ID) Default: "" Survey identifier
surveyName required	string (Survey Name) Default: "" Survey name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"surveyId": "S128765",
"surveyName": "Survey #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Survey Update Signal

Processes Survey Update Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

surveyId required	string (Survey ID) Default: "" Survey identifier
surveyName required	string (Survey Name) Default: "" Survey name
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"surveyId": "S128765",
"surveyName": "Survey #234",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Ecommerce signals

Cart Add Signal

Processes Cart Add signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
cartId required	string (Cart ID) Default: "" Id of the Cart
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "example.com",
"cartId": "cart",
"email": "john.doe@cheetahdigital.com",
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "offer",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Cart Clear Signal

Processes Cart Clear signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
cartId required	string (Cart ID) Default: "" Id of the Cart
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"cartId": "cart",
"email": "john.doe@cheetahdigital.com",
"site": "www.example.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Cart Purchase Signal

Processes Cart Purchase signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
cartId required	string (Cart ID) Default: "" Id of the Cart
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
transactionId required	string (Transaction ID) Default: "" Transaction ID generated by the customer
transactionSource required	string (Transaction Source) Default: "" Transaction source of order
total required	number (Final total) Default: 0 Total sum of purchase
currency required	string (Currency) Default: "" Currency the transaction took place in.
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"cartId": "cart",
"email": "john.doe@cheetahdigital.com",
"site": "www.example.com",
"transactionId": "2a3c8c6c-54ee-47d6-97fc-0cbc8e0faf39",
"transactionSource": "POS-XYZ",
"currency": "EUR",
"total": 95.5,
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Cart Remove Signal

Processes Cart Remove signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
cartId required	string (Cart ID) Default: "" Id of the Cart
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "www.example.com",
"cartId": "id",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"type": "offer",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Cart Replace Signal

Processes Cart Replace signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
cartId required	string (Cart ID) Default: "" Id of the Cart
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"email": "john.doe@cheetahdigital.com",
"site": "www.example.com",
"cartId": "id",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "offer",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Customer Service Review Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
required	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "example.com",
"email": "john.doe@cheetahdigital.com",
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Servives",
"subcategory": "Network",
"type": "item",
"name": "Network installation",
"description": "100 GB Netwokr installation",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Cancel Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Delay Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "123454",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Deliver Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Return Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Ship Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Ship Delete Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Ship Partial Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Ship Update Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

orderId required	string (Order ID) Default: "" Id of the Order
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"orderId": "12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "purchase",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Order Payment Revoked Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
paymentId required	string (Payment ID) Default: "" Payment ID generated by the customer
paymentSource required	string (Payment Source) Default: "" Payment source of order
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"email": "john.doe@cheetahdigital.com",
"paymentId": "2a3c8c6c-54ee-47d6-97fc-0cbc8e0faf39",
"paymentSource": "POS-XYZ",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Item Review Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

site required	string (Site) Default: "" Site or domain
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
required	Array of objects (Items) Default: [] List of Items
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"site": "example.com",
"cartId": "cart",
"email": "john.doe@cheetahdigital.com",
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
},
"items": [{"category": "Shoes",
"subcategory": "Mens",
"type": "offer",
"name": "Nike Men's Revolution 5 Running Shoe",
"description": "REVOLUTIONARY COMFORT: The Nike Revolution 5 men's running shoes cushion your stride with soft foam to keep you running in comfort. Minimalist design fits in just about anywhere your day takes you.",
"sku": "XYZ12345",
"quantity": 1
}
]
}
}

Mobile app signals

Mobile App Close Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

mobileAppId required	string (Object ID) Default: "" Unique ID for application group
mobileAppName required	string (Object Name) Default: "" Application group name
deviceType required	string (Device Type) Default: "" Device type derived from user agent
devicePlatformName required	string (Device Platform Name) Default: "" Platform name derived from user agent
deviceId required	string (Device ID) Default: "" identifier for device. (GUID)
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
appId	string (App ID) Default: "" Profile App ID
phone	string (User Profile Phone) Default: "" Profile Phone
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"mobileAppId": "1001",
"mobileAppName": "Best Shopping +",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Mobile App Install Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

mobileAppId required	string (Object ID) Default: "" Unique ID for application group
mobileAppName required	string (Object Name) Default: "" Application group name
deviceType required	string (Device Type) Default: "" Device type derived from user agent
devicePlatformName required	string (Device Platform Name) Default: "" Platform name derived from user agent
deviceId required	string (Device ID) Default: "" identifier for device. (GUID)
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
appId	string (App ID) Default: "" Profile App ID
phone	string (User Profile Phone) Default: "" Profile Phone
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"mobileAppId": "1001",
"mobileAppName": "Best Shopping +",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Mobile App Open Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

mobileAppId required	string (Object ID) Default: "" Unique ID for application group
mobileAppName required	string (Object Name) Default: "" Application group name
deviceType required	string (Device Type) Default: "" Device type derived from user agent
devicePlatformName required	string (Device Platform Name) Default: "" Platform name derived from user agent
deviceId required	string (Device ID) Default: "" identifier for device. (GUID)
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
appId	string (App ID) Default: "" Profile App ID
phone	string (User Profile Phone) Default: "" Profile Phone
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"mobileAppId": "1001",
"mobileAppName": "Best Shopping +",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Mobile App Registration Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

mobileAppId required	string (Object ID) Default: "" Unique ID for application group
mobileAppName required	string (Object Name) Default: "" Application group name
deviceType required	string (Device Type) Default: "" Device type derived from user agent
devicePlatformName required	string (Device Platform Name) Default: "" Platform name derived from user agent
deviceId required	string (Device ID) Default: "" identifier for device. (GUID)
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
appId	string (App ID) Default: "" Profile App ID
phone	string (User Profile Phone) Default: "" Profile Phone
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"mobileAppId": "1001",
"mobileAppName": "Best Shopping +",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Mobile App Uninstall Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

mobileAppId required	string (Object ID) Default: "" Unique ID for application group
mobileAppName required	string (Object Name) Default: "" Application group name
deviceType required	string (Device Type) Default: "" Device type derived from user agent
devicePlatformName required	string (Device Platform Name) Default: "" Platform name derived from user agent
deviceId required	string (Device ID) Default: "" identifier for device. (GUID)
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
appId	string (App ID) Default: "" Profile App ID
phone	string (User Profile Phone) Default: "" Profile Phone
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
categories	Array of strings (Categories) Default: [] List of categories associated with the event
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"mobileAppId": "1001",
"mobileAppName": "Best Shopping +",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Lifecycle signals

Lifecycle Cancellation Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

cancellationInterest required	string (Cancellation Interest) Default: "" Cancellation Interest
cancellationType required	string (Cancellation Type) Default: "" Enum: "newsletter" "webinar" "event" "site" "program" "game" Cancellation Type
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"cancellationInterest": "G128765",
"cancellationType": "newsletter",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Lifecycle Milestone Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

milestoneId required	string (Milestone ID) Default: "" Milestone identifier
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"milestoneId": "25 years of Test Shop",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Lifecycle Service Disruption Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

serviceId required	string (Service ID) Default: "" Service Identification
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"serviceId": "G128765",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Lifecycle Service Resume Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

serviceId required	string (Service ID) Default: "" Service Identification
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"serviceId": "G128765",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Lifecycle Signup Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

signupInterest required	string (Signup Interest) Default: "" Signup interest identifier
signupType required	string (Signup Type) Default: "" Enum: "newsletter" "webinar" "event" "site" "program" "game" Signup Type
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"signupInterest": "G128765",
"signupType": "newsletter",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Catalog signals

Product Back in Stock Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

productId required	string (Product ID) Default: "" Id of the Product
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"productId": "ITEM12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}

Product Out of Stock Signal

Request Body schema: application/json

specversion

required

string (Schema version)

Default: "1.0"

Schema version

Value: "1.0"

type

required

string (Type)

Default: "event.signal"

The classification/category of event

Value: "event.signal"

dataschema

required

string (Data Schema)

Default: "evt:signal/v1"

A reference to the definition of the structure of data

Value: "evt:signal/v1"

id

required

string (Event ID)

Default: ""

Identifier for event. Unique per source. GUID

traceId

string (Trace ID)

Default: ""

Unique ID for tracing request across systems

source

string

Default: ""

Globally Unique Platform identifier. ':'

time

required

string (Time)

Default: ""

Date and time an event / activity the event relates to

required

Data section of the Signal event (object) or Data section of the Signal event (object) (Data section of the Signal event)

The payload of the event

Any of

productId required	string (Product ID) Default: "" Id of the Product
email required	string (Email) Default: "" User email
idType	string (User identification type) Default: "email" Enum: "external" "email" "phone" "deviceId" "appId" "marketing" Type of the user identification: email, external, phone etc
customerId	string (Customer based User ID) Default: "" Customer based User identification
profileId	string (Marketing profile ID) Default: "" User marketing profile ID
	object (Profile Attributes) Flexible mechanism to store custom attributes of the member profile
	object (Event Attributes) Flexible mechanism to store custom attributes related to the event
categories	Array of strings (Categories) Default: [] List of categories associated with the event
property name* additional property	string or null

Responses

Request samples

Payload

Content type

application/json

{"specversion": "1.0",
"type": "event.signal",
"dataschema": "evt:signal/v1",
"id": "message identifier 1",
"time": "2007-04-05T14:32:10.700Z",
"data": {"productId": "ITEM12345",
"email": "john.doe@cheetahdigital.com",
"eventAttributes": {"channel": "Email message",
"ip": "127.0.0.2",
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6 like Mac OS X)",
"deviceType": "ios",
"country": "US",
"state": "CA",
"city": "Synnyvale",
"postalCode": "94089"
},
"profileAttributes": {"profileCity": "Sunnyvale",
"profileState": "CA",
"profilePostalCode": "94089",
"profileLastName": "Doe",
"profileFirstName": "John"
}
}
}