`debug` Debug

A heartbeat or debug message from an integration script.

When to send it

Integration scripts, through /debug or sendDebugEvent.

Needs no shopper consent.
Kept 7 days.
Send tracking_id when you have it: without one the event is kept but marked untracked.

Required fields

Field	Type	Rules
`client_id`	`integer`	greater than 0
`event`	`"__debug__"`
`timestamp_ms`	`integer`
`message`	`string`

Optional fields

Field	Type	Rules
`tracking_id`	`string`	a UUID
`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
`product_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`
`context`	`object`
`debug_event`	`string`	1–64 characters

Example

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

{
  "event": "__debug__",
  "client_id": 1000,
  "timestamp_ms": 1792000000000,
  "message": "Order script loaded / test/order.js"
}

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.

Level	Check	Message
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>
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
warning	`untracked`	untracked: no tracking_id. The event is kept but cannot be joined to the widget visitor.

JSON schema

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

__debug__ Debug