Messaging System Schemas

Docs

More information about Messaging System.

Messages

There are JSON schemas for each type of message that the Firefox Messaging System handles:

• CFR URLBar Chiclet

• Extension Doorhanger

• Infobar

• Spotlight

• Toolbar Badge

• Update Action

• Whats New

• Private Browsing Newtab Promo Message

Together, they are combined into the Messaging Experiments via a script. This is the schema used for Nimbus experiments that target messaging features. All incoming messaging experiments will be validated against these schemas.

To add a new message type to the Messaging Experiments schema:

1. Ensure the schema has an $id member. This allows for references (e.g., { "$ref": "#!/$defs/Foo" }) to work in the bundled schema. See docs on bundling JSON schemas for more information.

2. Add the new schema to the list in make-schemas.py.

3. Build the new schema by running:

cd browser/components/newtab/schemas
../../../../../../mach python make-schemas.py

4. Commit the results.

Triggers and actions

• User Actions
  • Usage
  • Available Actions
• Trigger Listeners
  • Usage
  • Available trigger actions