Skip to main content
Judge.me logo
  • Category: reviews
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 34
  • Triggers: 0
  • Slug: JUDGE_ME
  • Version: 20261101_00

Tools

Slug: JUDGE_ME_BULK_CREATE_WEBHOOKSCreate multiple webhook subscriptions in one request.

Input Parameters

array
required
Webhook subscriptions to create in one request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_BULK_UPDATE_REVIEW_VISIBILITYSequentially publish, hide, archive, or unarchive 1-25 reviews. Each update uses a separate request, and the response reports a per-item outcome so one rejected update does not hide partial completion.

Input Parameters

array
required
One to 25 review visibility updates to process in order. Each item must set curated or hidden so the batch cannot report a no-op as successful.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_COUNT_REVIEWSCount management review records, optionally filtered by reviewer, product, and star rating. Use the storefront aggregate count action for widget-facing all-review or shop-review totals.

Input Parameters

integer ("1" | "2" | "3" | "4" | "5")
Only count reviews with this star rating.
integer
Judge.me internal product ID to count reviews for.
integer
Judge.me internal reviewer ID to count reviews for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_COUNT_STOREFRONT_REVIEWSReturn the storefront aggregate review count for either all product and shop-level reviews or only shop-level reviews.

Input Parameters

string ("all" | "shop")
required
Whether to count all product and shop-level reviews or only shop-level reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_CREATE_CHECKOUT_COMMENTPersist a customer’s comment for a product through Judge.me’s documented Checkout Comments operation. Requires the shop’s Checkout Comments app entitlement.

Input Parameters

string
Checkout comment content to persist.
object
Customer associated with the checkout comment.
string ("checkout_page" | "email")
Source from which the checkout comment was created.
integer
External commerce-platform ID of the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_CREATE_PRIVATE_REPLYCreate a private reply to a review and, by default, email it to the reviewer.

Input Parameters

integer
required
Judge.me internal ID of the review whose reviewer receives the private reply.
string
required
Body of the private reply email.
string
required
Subject of the private reply email.
boolean
Whether Judge.me sends the private reply by email to the reviewer. Defaults to true and causes an external email side effect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_CREATE_PUBLIC_REPLYPost a public reply to a review and optionally email it to the reviewer. Email sending defaults to enabled.

Input Parameters

string
required
Public reply text.
integer
required
Judge.me internal ID of the review to reply to.
boolean
Whether Judge.me also emails the public reply to the reviewer. Defaults to true; set false to post without sending email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_CREATE_REVIEWSubmit a public web review in the background; no review is created when the shop disables web reviews.

Input Parameters

string
required
Review text.
string
Optional review title.
integer ("1" | "2" | "3" | "4" | "5")
required
Star rating from 1 to 5.
string ("shopify" | "woocommerce" | "bigcommerce")
required
Commerce platform used by the shop.
string
required
Domain of the shop receiving the review.
array
Public URLs of pictures attached to the review.
string
required
Public name of the reviewer.
string
required
Email address of the reviewer.
array
Custom-form answers for the review.
integer
External product ID; omit to create a shop-level review.
string
Reviewer IP address used for location; omit to let Judge.me use the caller IP.
string ("" | "last_initial" | "all_initials" | "anonymous")
How the reviewer prefers their name displayed publicly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_CREATE_WEBHOOKCreate one webhook subscription for a Judge.me event and callback URL.

Input Parameters

string ("widget/settings/updated" | "widget/review_widget/updated" | "widget/preview_badge/updated" | "widget/all_reviews_count/updated" | "widget/all_reviews_rating/updated" | "widget/shop_reviews_count/updated" | "widget/shop_reviews_rating/updated" | "widget/verified_badge/updated" | "widget/all_reviews_page/updated" | "widget/featured_carousel/updated" | "widget/reviews_tab/updated" | "widget/html_miracle/updated" | "widget/product_comment/updated" | "review/created" | "review/updated" | "review/created_fail")
required
Judge.me event key that triggers the webhook.
string
required
URL that receives Judge.me webhook POST requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_DELETE_WEBHOOKDelete the webhook subscription matching its current Judge.me event key and callback URL.

Input Parameters

string ("widget/settings/updated" | "widget/review_widget/updated" | "widget/preview_badge/updated" | "widget/all_reviews_count/updated" | "widget/all_reviews_rating/updated" | "widget/shop_reviews_count/updated" | "widget/shop_reviews_rating/updated" | "widget/verified_badge/updated" | "widget/all_reviews_page/updated" | "widget/featured_carousel/updated" | "widget/reviews_tab/updated" | "widget/html_miracle/updated" | "widget/product_comment/updated" | "review/created" | "review/updated" | "review/created_fail")
required
Current Judge.me event key of the webhook to delete.
string
required
Current callback URL of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_ALL_REVIEWS_PAGE_WIDGETReturn rendered HTML for one page of the shop’s all-reviews page.

Input Parameters

integer
Review page to render.
string ("product-reviews" | "shop-reviews")
Whether to render product reviews or shop-level reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_CHECKOUT_COMMENTS_WIDGETReturn rendered Checkout Comments widget HTML for one product; requires the Checkout Comments app.

Input Parameters

integer
Judge.me internal product ID; provide exactly one product selector.
string
Product handle; provide exactly one product selector.
integer
External commerce-platform product ID; provide exactly one product selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_CURRENT_SHOPReturn identity, plan, platform, owner, and widget metadata for the OAuth-connected shop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_PRODUCTReturn a product by Judge.me internal ID, external commerce-platform ID, or product handle.

Input Parameters

string
Product handle. Provide exactly one product selector.
integer
Judge.me internal product ID. Provide exactly one product selector.
integer
External commerce-platform product ID. Provide exactly one product selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_PRODUCT_PREVIEW_BADGEReturn the rendered rating-and-review-count badge HTML for one product.

Input Parameters

integer
Judge.me internal product ID; provide exactly one product selector.
string
Product handle; provide exactly one product selector.
integer
External commerce-platform product ID; provide exactly one product selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_PRODUCT_REVIEW_WIDGETReturn the rendered review-widget HTML for one product and, optionally, one review page.

Input Parameters

integer
Review page rendered inside the widget.
integer
Maximum reviews rendered in the widget page.
integer
Judge.me internal product ID; provide exactly one product selector.
string
Product handle; provide exactly one product selector.
integer
External commerce-platform product ID; provide exactly one product selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_REVIEWReturn one review by its Judge.me internal ID.

Input Parameters

integer
required
Judge.me internal review ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_REVIEWERReturn a reviewer by Judge.me internal ID, external commerce-platform ID, or email address.

Input Parameters

string
Reviewer email address. Provide exactly one reviewer selector.
integer
External commerce-platform reviewer ID. Provide exactly one reviewer selector.
integer
Judge.me internal reviewer ID. Provide exactly one reviewer selector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_REVIEWS_RATINGReturn the average rating for all product and shop-level reviews or for shop-level reviews only.

Input Parameters

string ("all" | "shop")
required
Review set to average: all includes product and shop-level reviews; shop includes only shop-level reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_REVIEWS_TAB_WIDGETReturn the rendered floating reviews-tab HTML for a selected review type and page.

Input Parameters

integer
Review page rendered in the tab.
integer
Maximum reviews rendered in the tab page.
string ("product-reviews" | "shop-reviews")
Whether to render product reviews or shop-level reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_SETTINGSReturn values for one or more named Judge.me shop settings.

Input Parameters

array
required
One to 100 Judge.me setting keys to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_VERIFIED_REVIEWS_BADGEReturn the rendered verified-review-count badge, or null when the shop has fewer than 20 verified reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_WEBHOOKReturn one webhook subscription by its Judge.me internal ID.

Input Parameters

integer
required
Judge.me internal webhook ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_WIDGET_PLACEHOLDER_HTMLReturn the rendered placeholder HTML used before Judge.me widget JavaScript and CSS load.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_GET_WIDGET_SETTINGS_HTMLReturn the shop’s rendered widget customization script and style HTML, not structured setting values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_LIST_REVIEWSReturn one page of reviews, optionally filtered by reviewer, product, rating, published-only state, or reviewer email. Full pages can yield a continuation whose final page is empty because Judge.me returns no total count.

Input Parameters

integer ("1" | "2" | "3" | "4" | "5")
Only return reviews with this star rating.
integer
Maximum reviews to return in this page (1-100).
boolean
Set true to return only storefront-published reviews. Omit to return reviews regardless of publication state; Judge.me does not honor false as an unpublished-only filter.
integer
Judge.me internal product ID to filter by. An ID outside this shop may fall back to all shop reviews.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
integer
Judge.me internal reviewer ID to filter by.
string
Only return reviews from this reviewer email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_LIST_WEBHOOKSReturn all webhook subscriptions configured for the connected shop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_REQUEST_REVIEWER_DATASubmit a reviewer data request for a customer email and one or more external order IDs. The submitted privacy workflow cannot be undone.

Input Parameters

string
required
Customer email whose data is requested.
array
required
External order IDs to include in the data request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_UNINSTALL_SHOPWARNING: This uninstalls Judge.me from the OAuth-connected shop and must only be called intentionally.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_UPDATE_CURRENT_SHOPUpdate selected profile and commerce metadata for the OAuth-connected shop. Use only with values intended to replace current shop data.

Input Parameters

string
Replacement shop display name.
string
Replacement Judge.me plan value. Only send this when explicitly authorized to manage plan metadata.
string
Replacement shop contact email.
string
Replacement shop owner name.
string
Replacement shop phone number.
string
Replacement platform shop domain.
string
Replacement two-letter shop country code.
string
Replacement shop timezone in Judge.me’s accepted display format.
string
Replacement custom storefront domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_UPDATE_REVIEW_VISIBILITYPublish, hide, archive, or unarchive a review. Review text cannot be edited through this action.

Input Parameters

boolean
Whether to archive the review. true also hides it; publishing a review also unarchives it.
string ("ok" | "spam")
Set to ok to publish the review or spam to hide it.
integer
required
Judge.me internal review ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_UPDATE_WEBHOOKReplace a webhook subscription’s event key and callback URL.

Input Parameters

string ("widget/settings/updated" | "widget/review_widget/updated" | "widget/preview_badge/updated" | "widget/all_reviews_count/updated" | "widget/all_reviews_rating/updated" | "widget/shop_reviews_count/updated" | "widget/shop_reviews_rating/updated" | "widget/verified_badge/updated" | "widget/all_reviews_page/updated" | "widget/featured_carousel/updated" | "widget/reviews_tab/updated" | "widget/html_miracle/updated" | "widget/product_comment/updated" | "review/created" | "review/updated" | "review/created_fail")
required
Replacement Judge.me event key.
integer
required
Judge.me internal ID of the webhook to update.
string
required
Replacement callback URL that receives webhook requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JUDGE_ME_UPSERT_REVIEWERCreate or update a reviewer using a Judge.me ID, or using email with an optional external commerce ID. Email and name are required.

Input Parameters

string
required
Reviewer name.
array
Reviewer tags. Judge.me stores these as a comma-separated value.
string
required
Reviewer email address.
string
Reviewer phone number.
integer
External commerce-platform reviewer ID used to locate or create the reviewer.
integer
Judge.me internal reviewer ID for an existing reviewer.
string
ISO 8601 timestamp when the reviewer unsubscribed from marketing.
boolean
Whether the reviewer accepts marketing messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not