browsingContext.navigationFailed event

Event data

The params field in the event notification is an object with the following fields:

context

A string that contains the ID of the context in which the navigation failed.

navigation

A string that contains the UUID that uniquely identifies this navigation. If the navigation was started using the browsingContext.navigate or browsingContext.reload command, this ID matches the navigation value in the command's response. The same ID is shared by all events related to this navigation, including other navigation events in the browsingContext module and events in the network module.

timestamp

A non-negative integer that represents the time when the event was fired, as milliseconds elapsed since the epoch.

url

A string that contains the URL being loaded.

Description

In the lifecycle of a navigation, this event fires when the navigation is blocked, for example because of a security or CSP restriction or because the client cancels the unload prompt.

Examples

Receiving an event when a cross-document navigation is blocked

Assume you have a WebDriver BiDi connection and an active session with a subscription to browsingContext.navigationFailed. The session's unhandledPromptBehavior capability is configured to dismiss beforeunload prompts. The current page also has a beforeunload handler that calls event.preventDefault() to warn before leaving.

Suppose there are unsaved changes on this page and you use browsingContext.navigate to load a different URL.

The browser opens the beforeunload prompt, fires a browsingContext.navigationStarted event, and blocks the navigation. The browser sends the following notification, where the context value matches the context ID you passed to browsingContext.navigate, and the navigation value is the ID of the blocked navigation:

{
  "type": "event",
  "method": "browsingContext.navigationFailed",
  "params": {
    "context": "5e5e96e8-5247-4f22-9b35-a4a2d841cbaa",
    "navigation": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "timestamp": 1712345678901
  }
}

Specifications

Browser compatibility

See also

• browsingContext.navigationStarted event
• browsingContext.navigationCommitted event