Skip to content

Add instructions on finding the ID of an existing extension#2237

Merged
willdurand merged 4 commits into
masterfrom
existing-addon-id
May 21, 2026
Merged

Add instructions on finding the ID of an existing extension#2237
willdurand merged 4 commits into
masterfrom
existing-addon-id

Conversation

@Rob--W
Copy link
Copy Markdown
Member

@Rob--W Rob--W commented Jan 5, 2026

This PR adds instructions on finding the ID of an existing extension.

Note that the instructions include "install" as part of the workflow. This is acceptable for workflows where one wants to update their own extension. I can imagine scenarios where one does not want or cannot install the previous version of the extension. In that case, they could visit https://robwu.nl/crxviewer/ , specify the URL of the extension (or select the xpi file in the file chooser), then click on manifest.json in the sidebar, then click on the Show analysis button to reveal the Extension ID field.

It also fixes a few minor issues:

  • doubly listed contributor
  • incorrectly formatted link due to use of ] instead of ) to close [...](...)
  • Remove However, from a sentence that did not describe an opposing statement.

@Rob--W Rob--W requested a review from rebloor January 5, 2026 13:56
@rebloor rebloor added the content label Jan 5, 2026
Copy link
Copy Markdown
Collaborator

@rebloor rebloor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Rob--W left some suggestions for your consideration


See [`browser_specific_settings` in manifest.json](https://developer.mozilla.org/Add-ons/WebExtensions/manifest.json/browser_specific_settings) for the syntax of setting the extension ID.

To find the ID for an extension that has already been published, install your existing extension from AMO, visit `about:debugging` and look at the `Extension ID` field of your extension.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To find the ID for an extension that has already been published, install your existing extension from AMO, visit `about:debugging` and look at the `Extension ID` field of your extension.
To find a published extension's ID, install the extension from AMO, visit `about:debugging`, and check the **Extension ID** field.

Comment thread src/content/documentation/develop/extensions-and-the-add-on-id.md Outdated
Comment thread src/content/documentation/develop/extensions-and-the-add-on-id.md Outdated
@wagnerand-moz
Copy link
Copy Markdown
Member

There must be a better way to view the ID on AMO, and not naving to reside to a personal website or installing the add-on. Can we start exposing this on the AMO listing page?

Maybe we can also have a dedicated section on this page, rather than repeating the same information several times. That section could also include to open the manifest file and inspect browser_specific_settings, if you have the XPI file, or only have that, e.g. for self-hosted add-ons.

@uncenter
Copy link
Copy Markdown

uncenter commented Jan 8, 2026

There must be a better way to view the ID on AMO, and not naving to reside to a personal website or installing the add-on. Can we start exposing this on the AMO listing page?

I'm wondering if it is the same as this UUID field? It's labeled as UUID but the ? tooltip says "The UUID of your add-on is specified in its install manifest and uniquely identifies it. You cannot change your UUID once it has been submitted." Seems to be conflating the UUID format/terminology with the manifest ID so I'm not sure.

CleanShot 2026-01-08 at 16 25 05@2x

@wagnerand-moz
Copy link
Copy Markdown
Member

@uncenter Yes, in this specific case UUID and Add-on ID are the same. Sometimes we also call it GUID. It's confusing, I know. To add even more to that, Firefox also has an install-specific UUID that is exposed on about:debugging. We should probably rename that field in devhub to "Add-on ID", as that is the term we are using publicly.

@Rob--W could you file an issue on https://github.com/mozilla/addons/ to ask that we show the add-on ID in the "More information" section on the listing page?

@uncenter raises a good point. Developers generally know how to look up their ID or at least can access it through that devhub field. This documentation might be used by users or developers who don't own the particular add-on they want to look up the ID for, for example to find the listing page, or to report it to Mozilla.
If we want to advise non-owners to install an add-on just to get its ID, we might want to add a notice that this should be done in a separate profile (thinking about the reporting case). We probably don't have to guide them through how to do that, I assume there is a SUMO page we can link to.

@Rob--W
Copy link
Copy Markdown
Member Author

Rob--W commented Jan 14, 2026

@Rob--W could you file an issue on https://github.com/mozilla/addons/ to ask that we show the add-on ID in the "More information" section on the listing page?

Done: mozilla/addons#16011

I will wait a little bit with updating this PR, say 1-2 weeks, to see if the feature request can be addressed quickly. If so, then the instruction on getting the ID would be much better than "install the extension". I don't really want to recommend installing the extension to know the extension ID if possible. While it may be acceptable for self-developed extensions, it is a bad practice for arbitrary third-party extensions.

@rebloor
Copy link
Copy Markdown
Collaborator

rebloor commented Apr 21, 2026

@Rob--W the other change doesn't seem to be progressing, do you want to merge this?

@wagnerand-moz
Copy link
Copy Markdown
Member

wagnerand-moz commented Apr 22, 2026

Fwiw, I'd agree with Rob that it'd be good to avoid asking users to install random add-ons for this purpose, if we can.

The issue received guidance from UX recently, which is a good sign. It looks to me that at least the MVP would be a trivial change. It is assigned and has a higher-than-normal priority, so I believe we should be able to get to that in the next couple of weeks.

@rebloor
Copy link
Copy Markdown
Collaborator

rebloor commented Apr 23, 2026

Thanks @wagnerand-moz I'll leave as is for the moment then.

@wagnerand-moz
Copy link
Copy Markdown
Member

@Rob--W @rebloor The ID can be copied from the listing page now (mozilla/addons#16011). Do we want to update or close this PR?

@rebloor
Copy link
Copy Markdown
Collaborator

rebloor commented May 19, 2026

@Rob--W unless you get there before me, I'll look at updating this in the next couple of days

rebloor added 2 commits May 20, 2026 06:59
Updated instructions for finding the ID of a published extension.
Co-authored-by: rebloor <git@sherpa.co.nz>
Comment thread src/content/documentation/develop/extensions-and-the-add-on-id.md Outdated
@rebloor
Copy link
Copy Markdown
Collaborator

rebloor commented May 19, 2026

@Rob--W @wagnerand-moz I've made the update here. Looks like I can merge. But I'll wait for your confirmation

Copy link
Copy Markdown
Member

@wagnerand-moz wagnerand-moz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm, thank you!

@willdurand willdurand merged commit b475e7d into master May 21, 2026
1 check passed
@willdurand willdurand deleted the existing-addon-id branch May 21, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants