| version | | type | "string" |
|---|
| required | true |
|---|
| description | "References the full specifications of the current version of Echo (adding new notification types or changing the schema requires a version change), example: 1.1" |
|---|
|
|---|
| context | | type | "string" |
|---|
| enum | | "flyout" |
| "archive" |
| "mobile-overlay" |
| "mobile-archive" |
|
|---|
| description | "Context in which the action occurred, applies to all actions except for badge-link-click" |
|---|
|
|---|
| action | | type | "string" |
|---|
| required | true |
|---|
| enum | | "notification-impression" |
| "notification-link-click" |
| "notification-bundle-expand" |
| "mark-all-read-click" |
| "mark-entire-xwiki-bundle-read-click" |
| "special-page-visit" |
| "ui-archive-link-click" |
| "ui-badge-link-click" |
| "ui-help-click" |
| "ui-prefs-click" |
|
|---|
| description | "List of possible client-side actions. ui-* actions refer to UI elements, notification-* actions refer to individual notifications.
ui-badge-link-click is fired when the user clicks on the badge and has no context; ui-archive-link-click can only have flyout as a context; ui-help-click and ui-prefs-click actions can occur in the flyout and archive context. mark-all-read-click is fired when the user clicks the mark all read button, either in the popup or the special page. mark-entire-xwiki-bundle-read-click is fired when an entire cross-wiki bundle is marked as read." |
|---|
|
|---|
| eventId | | type | "integer" |
|---|
| description | "Unique identifier of the event triggering the current notification (matching the same field in Schema:Echo), only available for notification-* actions." |
|---|
|
|---|
| notificationType | | type | "string" |
|---|
| description | "Type of notification, matching definitions from Schema:Echo. This is only available for notification-* actions." |
|---|
|
|---|
| userId | | type | "integer" |
|---|
| description | "User ID, change to required if the feature is being tested on registered only" |
|---|
| required | true |
|---|
|
|---|
| editCount | | type | "integer" |
|---|
| description | "Lifetime edit count, for registered users only" |
|---|
|
|---|
| mobile | | type | "boolean" |
|---|
| description | "True if interaction happened in a mobile interface" |
|---|
| required | false |
|---|
|
|---|
| notifWiki | | type | "string" |
|---|
| description | "Wiki the notification is from, omitted if the notification is from the current wiki" |
|---|
| required | false |
|---|
|
|---|
