By providing a fully documented API reference, we want to enable everyone to maximize the usage of the Interactive Moments platform
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.
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 |
We provide the API specification in the format of OpenApi files which can be found in the openapi/ directory:
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",
}
}
}
Lifecycle Signup Signal
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
|
{- "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": "Newspaper subscription #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"
}
}
}
Lifecycle Cancellation Signal
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
|
{- "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
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
|
{- "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
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
|
{- "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
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
|
{- "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"
}
}
}
Processes Game Start Signal
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
|
{- "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"
}
}
}
Processes Game End Signal
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
|
{- "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"
}
}
}
Processes Game Update Signal
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
|
{- "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"
}
}
}
Processes Booking Start Signal
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
|
{- "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"
}
}
}
Processes Booking Complete Signal
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
|
{- "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"
}
}
}
Processes Booking Update Signal
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
|
{- "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"
}
}
}
Processes Survey Start Signal
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
|
{- "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"
}
}
}
Processes Survey Complete Signal
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
|
{- "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"
}
}
}
Processes Survey Update Signal
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
|
{- "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"
}
}
}
Browse Category Complete Signal
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
|
{- "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"
]
]
}
}
Processes Browse Product Signal
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
|
{- "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"
}
]
}
}
Site Signin Signal
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
|
{- "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
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
|
{- "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"
}
}
}
Configuration Start Signal
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
|
{- "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
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
|
{- "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 Complete Signal
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
|
{- "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"
}
]
}
}
Processes Cart Add signal
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
|
{- "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
}
]
}
}
Processes Cart Remove signal
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
|
{- "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
}
]
}
}
Processes Cart Clear signal
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
|
{- "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"
}
}
}
Processes Cart Purchase signal
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
|
{- "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",
- "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
}
]
}
}
Processes Cart Replace signal
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
|
{- "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
}
]
}
}
Order Delay Signal
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
|
{- "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
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
|
{- "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
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
|
{- "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
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
|
{- "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
}
]
}
}
Item Review Signal Signal
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
|
{- "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
}
]
}
}
Customer Service Review Signal
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
|
{- "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
}
]
}
}