externally_connectable

The "externally_connectable" manifest property declares which extensions and web pages can connect to your extension via runtime.connect and runtime.sendMessage.

For a tutorial on message passing, see cross-extension messaging and sending messages from web pages.

# Connecting without externally_connectable

If the externally_connectable key is not declared in your extension's manifest, all extensions can connect, but no web pages can connect. As a consequence, when updating your manifest to use externally_connectable, if "ids": ["*"] is not specified, then other extensions will lose the ability to connect to your extension. This may be an unintended consequence, so keep it in mind.

# Manifest

{
  "name": "My externally connectable extension",
  "externally_connectable": {
    "ids": [
      "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      ...
    ],
    // If this field is not specified, no web pages can connect.
    "matches": [
      "https://*.google.com/*",
      "*://*.chromium.org/*",
      ...
    ],
    "accepts_tls_channel_id": false
  },
  ...
}

# Reference

The "externally_connectable" manifest key includes the following optional properties:

"ids"

The IDs of extensions that are allowed to connect. If left empty or unspecified, no extensions or apps can connect. The wildcard "*" will allow all extensions and apps to connect.

"matches"

The URL patterns for web pages that are allowed to connect. If left empty or unspecified, no web pages can connect. Patterns cannot include wildcard domains nor subdomains of (effective) top-level domains, for example:

"accepts_tls_channel_id"

Enables the extension to use the TLS channel ID of the web page connecting to it. The web page must also opt to send the TLS channel ID to the extension by setting includeTlsChannelId to true in runtime.connect's connectInfo or runtime.sendMessage's options. If set to false, runtime.MessageSender.tlsChannelId will never be set under any circumstance.

This does not affect content scripts.