Activity

Note

These APIs are not frozen and can change at any time without warning. See the API versions available for alternatives if you need stability. The only authentication method available at the moment is the internal one.

Listing Content Review

This endpoint allows you to view the listing content review history for an extension, and to request a new review if the listing is rejected (after you have addressed the reasons for the rejection).

GET /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/listingcontentreview/

Note

All add-ons require authentication and either reviewer permissions or a user account listed as a developer of the add-on.

Response JSON Object:

  • is_rejected (boolean) – Whether the listing content review was rejected.

  • can_request_review (boolean) – Whether a new listing content review can be requested. This is true if the add-on status is rejected, and developer has not yet requested a new review, false otherwise.

  • has_requested_review (boolean) – Whether the developer has requested a new listing content review after a rejection.

  • policies (string[]) – An array of policies the listing violated, for the listing content review rejection. Empty if not rejected.

  • comments (string|null) – The text content of the listing content review, if any. null if not rejected or if there were no comments.

Requesting Listing Content Review

This endpoint allows a new listing content review to be requested for an extension after a listing content review rejection, once the developer has addressed the reasons for the rejection.

Note

This API requires authentication, and for the user to be an author of the add-on.

PATCH /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/listingcontentreview/
Request JSON Object:

  • has_requested_review (boolean) – Whether the developer has requested a new listing content review after a rejection. Must be true to request a new review, and cannot be true if the listing content review was not rejected. If a new review has already been requested setting it does nothing currently.

Review Notes List

This endpoint allows you to list the approval/rejection review history for a version of an add-on.

GET /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/(int: id)/reviewnotes/

Note

All add-ons require authentication and either reviewer permissions or a user account listed as a developer of the add-on.

Response JSON Object:

  • count (int) – The number of versions for this add-on.

  • next (string) – The URL of the next page of results.

  • previous (string) – The URL of the previous page of results.

  • results (array) – An array of per version review notes.

Review Notes Detail

This endpoint allows you to fetch a single review note for a specific version of an add-on.

Note

To allow reviewers to stay anonymous if they wish, the user object only contains the name of the reviewer or author. That name may, for some actions, be an alias and not the usual name of the user.

GET /api/v5/addons/addon/(int:addon_id|string:addon_slug|string:addon_guid)/versions/(int: id)/reviewnotes/(int: id)/
Response JSON Object:

  • id (int) – The id for a review note.

  • action (string) – The type of review note.

  • action_label (string) – The text label of the action.

  • user.name (string) – The name of the reviewer or author.

  • comments (string) – The text content of the review note.

  • date (string) – The date the review note was created.

  • attachment_url (string|null) – The link to download the associated attachment, if any

Possible values for the action field:

Value

Description

approved

Version, or file in the version, was approved

rejected

Version, or file in the version, was rejected

review-requested

Developer requested review

more-information-requested

Reviewer requested more information from developer

super-review-requested

Add-on was referred to an admin for attention

comment

Reviewer added comment for other reviewers

review-note

Generic review comment

Incoming Mail End-point

This endpoint allows a mail server or similar to submit a json object containing single email into AMO which will be processed. The only type of email currently supported is a reply to an activity email (e.g an add-on review, or a reply to an add-on review). Any other content or invalid emails will be discarded.

POST /api/v5/activity/mail

Note

This API endpoint uses a custom authentication method. The value SecretKey in the submitted json must match one defined in settings.INBOUND_EMAIL_SECRET_KEY. The IP address of the request must match one defined in settings.ALLOWED_CLIENTS_EMAIL_API, if defined.

Request JSON Object:

  • SecretKey (string) – A value that matches settings.INBOUND_EMAIL_SECRET_KEY.

  • Message.TextBody (string) – The plain text body of the email.

  • To (array) – Array of To email addresses. All will be parsed, and the first matching the correct format used.

  • To[].EmailAddress (string) – An email address in the format reviewreply+randomuuidstring@addons.mozilla.org.