FailureEvent

A NonInteractiveEvent that is sent when a user action results in a error, like an invalid email when sending a form.

graph LR AbstractEvent["AbstractEvent<br><span class='requires_context'>requires:<br />ApplicationContext<span class='properties'>location_stack: array<br />global_contexts: array<br />_type: string<br />id: string<br />time: integer</span></span>"]; AbstractEvent --> NonInteractiveEvent; NonInteractiveEvent --> FailureEvent["FailureEvent<br><span class='properties'>message: string</span>"]; class FailureEvent diagramActive; click NonInteractiveEvent "/docs/taxonomy/reference/events/NonInteractiveEvent" "See details" _self

Diagram: NonInteractiveEvent

Requires

None.

Properties

typedescriptioncontains
location_stackarrayThe location stack is an ordered list (stack), that contains a hierarchy of location contexts that deterministically describes where an event took place from global to specific. The whole stack (list) is needed to exactly pinpoint where in the UI the event originated.[AbstractLocationContext]
global_contextsarrayGlobal contexts add global / general information about the event. They carry information that is not related to where the Event originated (location), such as device, platform or business data.[AbstractGlobalContext]
_typestringString containing the name of the event type. (eg. PressEvent).
idstringUnique identifier for a specific instance of an event. Typically UUID's are a good way of implementing this. On the collector side, events should be unique, this means duplicate id's result in not ok events.pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[a-f0-9]{4}-[a-f0-9]{12}$
timeintegerTimestamp indicating when the event was generated.
messagestringFailure message.
setting of properties

The tracker will automatically set all the properties. The message is an error code or short message captured from the occurring error. This is purely for descriptive purposes.