API docs by Redocly

Signal API (0.1)

URL: http://meetmarigold.com License: All Rights Reserved

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:

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

Generated JWT token

Response samples

Content type
application/json
{
  • "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkxMSIsImF1ZCI6InN0cmluZyIsInJvbGVzIjpbIlJPTEVfVVNFUiJdLCJpc3MiOiJhdGxhcyIsImN1c3RvbWVySWQiOiIxIiwiZXhwIjoxNzMwMTMyOTEzLCJpYXQiOjE3MzAxMjkzMTN9.gzn0ddO3nirDKcp8v7wpk8L86gbl7wF2k-d_mePW_eA"
}

Cart Add Signal

Cart Add Signal endpoint

Processes Cart Add signal

Authorizations:
JwtToken
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"

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

required
Array of objects (Items)
Default: []

List of Items

property name*
additional property
string or null

Responses

Request samples

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": [
      • {
        }
      ]
    }
}

Cart Remove Signal

Cart Remove Signal endpoint

Processes Cart Remove signal

Authorizations:
JwtToken
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"

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

required
Array of objects (Items)
Default: []

List of Items

property name*
additional property
string or null

Responses

Request samples

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": [
      • {
        }
      ]
    }
}

Cart Clear Signal

Cart Clear Signal endpoint

Processes Cart Clear signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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

Cart Purchase Signal endpoint

Processes Cart Purchase signal

Authorizations:
JwtToken
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"

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

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

required
Array of objects (Items)
Default: []

List of Items

property name*
additional property
string or null

Responses

Request samples

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",
    • "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": [
      • {
        }
      ]
    }
}

Cart Replace Signal

Cart Replace Signal endpoint

Processes Cart Replace signal

Authorizations:
JwtToken
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"

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

required
Array of objects (Items)
Default: []

List of Items

property name*
additional property
string or null

Responses

Request samples

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": [
      • {
        }
      ]
    }
}

Game Start Signal

Game Start Signal endpoint

Processes Game Start Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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 End Signal

Game End Signal endpoint

Processes Game End Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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

Game Update Signal endpoint

Processes Game Update Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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"
      }
    }
}

Booking Start Signal

Booking Start Signal endpoint

Processes Booking Start Signal

Authorizations:
JwtToken
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"

Type of the user identification: email, external, phone etc

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

property name*
additional property
string or null

Responses

Request samples

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 Complete Signal

Booking Complete Signal endpoint

Processes Booking Complete Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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 Update Signal

Booking Update Signal endpoint

Processes Booking Update Signal

Authorizations:
JwtToken
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"

Type of the user identification: email, external, phone etc

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

property name*
additional property
string or null

Responses

Request samples

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"
      }
    }
}

Survey Start Signal

Survey Start Signal endpoint

Processes Survey Start Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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 Complete Signal

Survey Complete Signal endpoint

Processes Survey Complete Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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

Survey Update Signal endpoint

Processes Survey Update Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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"
      }
    }
}

Browse Category Signal

Browse Category Signal endpoint

Browse Category Complete Signal

Authorizations:
JwtToken
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"

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

sections
required
Array of strings (Sections) [ items ]
Default: []

List of Sections

property name*
additional property
string or null

Responses

Request samples

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": [
      • [
        ],
      • [
        ]
      ]
    }
}

Browse Product Signal

Browse Product Signal endpoint

Processes Browse Product Signal

Authorizations:
JwtToken
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"

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

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

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": [
      • [
        ],
      • [
        ]
      ],
    • "items": [
      • {
        }
      ]
    }
}

Site Signin Signal

Site Signin Signal endpoint

Site Signin Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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

Site Signout Signal endpoint

Site Signout Signal

Authorizations:
JwtToken
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"

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

property name*
additional property
string or null

Responses

Request samples

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"
      }
    }
}

Lifecycle Signup Signal

Lifecycle Signup Signal endpoint

Lifecycle Signup Signal

Authorizations:
JwtToken
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
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"

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

property name*
additional property
string or null

Responses

Request samples

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": "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

Lifecycle Cancellation Signal endpoint

Lifecycle Cancellation Signal

Authorizations:
JwtToken
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
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"

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

property name*
additional property
string or null

Responses

Request samples

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"
      }
    }
}