Skip to main content
POST
Report a widget event

Authorizations

X-Auth-Token
string
header
required

The signed session token from POST /api/v1/widget/config. Sent alongside website_token in the query string on every widget request. See /api-reference/widget-api-authentication.

Query Parameters

website_token
string
required

The web-widget inbox's public token, as it appears in your widget snippet. Required on every widget request.

Example:

"EXAMPLE_WEBSITE_TOKEN"

Body

application/json
name
string
required

The event name, e.g. webwidget.triggered.

event_info
object

Event payload, including the campaign id where one applies.

Response

Recorded