Event schemas

plugin_open Widget opened

The size finder panel opened.

When to send it

Shopper app, once each time the panel opens.

Required fields

Field Type Rules Description
client_id integer greater than 0
event "plugin_open"
tracking_id string a UUID
timestamp_ms integer
product_id string 1–255 characters
version string matches ^[0-9A-Za-z][0-9A-Za-z.+_-]{0,63}$

Optional fields

Field Type Rules Description
event_id string 1–255 characters
schema_version 1
user_agent string at most 2048 characters
shop_country string | null at most 8 characters; may be null
channel string | null at most 64 characters; may be null
instance_id string 1–255 characters
brand_id integer | null greater than 0; may be null
product_associated boolean
ab_data object
testEvent true
extra object
opening_time_ms integer | null may be null

Example

Test values only. This example passes the event's schema.

{
  "event": "plugin_open",
  "client_id": 1000,
  "tracking_id": "3f0b8c2e-4d5a-4b6c-8d7e-9f0a1b2c3d4e",
  "timestamp_ms": 1792000000000,
  "product_id": "TEST-JACKET-01",
  "version": "1.4.2",
  "opening_time_ms": 420
}

Checks and messages

What Tracking debug in your back office checks for this event, with its exact message. An error means the event is not counted; a warning means it is counted but something is likely wrong; an info is a hint.

LevelCheckMessage
error body_data the field: body data is not allowed here, the value was dropped (D110)
error invalid_field what is wrong with the field
error over_limit the field is over the limit of <limit>
error product_id_missing missing product_id
error tracking_id_missing missing tracking_id: the event is rejected. Send the visitor id (fmt_device_id) with every event.
warning product_unknown product not found in your catalogue or has no size chart
warning timestamp_missing timestamp_ms is missing or not a time in milliseconds: the time the event was received is used
warning timestamp_out_of_range timestamp_ms is more than 30 days old or more than 3 days ahead: the time the event was received is used

JSON schema

The schema the API checks this event against: plugin_open.schema.json.