User Event

User Event <user-event> [SUPPORT_IGNORED_UPDATE_CFS]

Name
Type
Required
Valid value / Description
Example

Custom Fields

source

String

Yes

Relate to Data Model:

CustomerIdentity: Customer

CustomerMembership: Membership

CustomerRelationship: Relationship

Contact: Contact

LeadInformation: Lead

PurchaseHistory: Purchase history

PurchaseOrder: Purchase order

ShoppingCart: Shopping Cart

OrderPayment: Order payment

MOM Code: Custom Model Code (M-NABC-O-MNHM-M)

CustomerMembership

sourceId

String

Yes

Id of the source object. For example, you are creating an event “Purchased” from Purchase history model, then:

sourceId = transactionId (TX009323)

098685xxxx

(Membership Id)

condition

String

Valid values: Changed | Created

  • Changed: New event will be created when eventAt is changed

  • Created: Create once for each sourceId

Default: Created

Changed

channel

String

Yes

Valid values: Online | Offline | None

Online

eventCtg

String

Yes

Valid Values:

  • CampaignBehaviour

  • UserIdentity

  • UserInteraction

  • Transaction

  • CustomerService

  • Other

CampaignBehaviour

eventCtg2

String

More detail of Category

eventCtg3

String

More detail of Category

eventName

String

Yes

Event Name

purchased

eventAt

Timestamp

Yes

Event Time

1656825748000

value

Double

A double value

430

eventLabels

Array

Event Labels

[ “type”, “source: 123” ]

eventLabel2s

Array

Event Labels

[ “link: http1” ]

eventLabel3s

Array

Event Labels

[ “link: http1” ]

customerId

String

Customer Id

C09320932032

email

String

Email address of an user

phone

String

Phone number of an user

098685xxxx

zaloOAId

String

Zalo OA Id

763845675567xxx

zaloUserId

String

Zalo User Id

5425775678654xxxxx

note

String

otes

recordStatus

String

This value determines whether this record is deleted or not.

Valid Values:

  • Active

  • NDeleted

Active

{
    "source": "CustomerMembership"
    "sourceId": "098686xxxx"
    "condition": "Changed"
    "channel": "Online"
    "eventCtg": "UserIdentity",
    "eventCtg2": "Activity"
    "eventCtg3": null,
    "eventName": "upgraded level",
    "eventAt": 1656825748000,
    "eventLabels": ["point: 123", "level: Silver"],
    "eventLabel2s": [],
    "eventLabel3s": [],
    "value": 123,
    "customerId": null,
    "email": "[email protected]",
    "phone": "098686xxxx"
    "zaloOAId": null,
    "zaloUserId": null,
    "note": null,
    "customFieldTexts": {},
    "customFieldLongs": {},
    "customFieldBooleans": {},
    "customFieldDoubles": {},
    "customFieldListTexts": {}.
    "customFieldTimestamps": {}
}

Note: khi truyền cần lưu ý đảm bảo cấu trúc như sau cho các loại eventLabels

  • "key: value"

  • "value"

Một số trường hợp sai như sau:

  • "key": "value"

Last updated

Was this helpful?