> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Judge.me (OAuth)

> Integrate your application with the Judge.me API

## 🚀 Quickstart

Connect to Judge.me with Nango and see data flow in 2 minutes.

<Steps>
  <Step id="create-integration" title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to **Integrations** -> *Configure New Integration* -> *Judge.me (OAuth)*.
  </Step>

  <Step id="authorize-judgeme" title="Authorize Judge.me">
    Go to **Connections** -> *Add Test Connection* -> *Authorize*, then log in to Judge.me. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step id="call-judgeme-api" title="Call the Judge.me API">
    Let's make your first request to the Judge.me API. Replace the placeholders below with your Nango API key, integration ID, and connection ID:

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/api/v1/reviews" \
          -H "Authorization: Bearer <NANGO-API-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

        const res = await nango.get({
            endpoint: '/api/v1/reviews',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/docs/reference/sdks/node#get-a-connection-with-credentials) or [API](/docs/reference/api/connection/get).

    ✅ You're connected! Check the **Logs** tab in Nango to inspect requests.
  </Step>

  <Step id="implement-nango" title="Implement Nango in your app">
    Follow our [Auth implementation guide](/docs/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Judge.me (OAuth) integration guides

Nango maintained guides for common use cases.

* [How do I link my account?](/docs/api-integrations/judgeme-oauth/connect)
  Find your Judge.me shop domain to connect your account.

* [How to register your own Judge.me OAuth app](/docs/api-integrations/judgeme-oauth/how-to-register-your-own-judgeme-oauth-api-oauth-app)
  Register an OAuth app with Judge.me and obtain credentials to connect it to Nango

Official docs: [Judge.me API documentation](https://judge.me/api)

## 🧩 Pre-built syncs & actions for Judge.me (OAuth)

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| Function name                    | Description                                                                  | Type                                           | Source code                                                                                                                                  |
| -------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `create-review`                  | Create a new review for a product.                                           | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/create-review.ts)                  |
| `create-webhook`                 | Register a webhook subscription for a review lifecycle event.                | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/create-webhook.ts)                 |
| `delete-webhook`                 | Remove a webhook subscription by id.                                         | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/delete-webhook.ts)                 |
| `get-product-review-widget`      | Fetch the ready-to-render review widget/badge HTML for one or more products. | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/get-product-review-widget.ts)      |
| `get-product`                    | Fetch a single product by its Judge.me product id                            | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/get-product.ts)                    |
| `get-review`                     | Fetch a single review by its Judge.me review id.                             | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/get-review.ts)                     |
| `get-reviewer`                   | Fetch a single reviewer profile by id.                                       | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/get-reviewer.ts)                   |
| `get-shop-settings`              | Fetch specific named settings for the shop.                                  | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/get-shop-settings.ts)              |
| `list-orders`                    | List orders known to Judge.me for this shop within a date range.             | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/list-orders.ts)                    |
| `list-products`                  | List products known to Judge.me for this shop.                               | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/list-products.ts)                  |
| `list-reviews`                   | List reviews for the shop with optional filters                              | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/list-reviews.ts)                   |
| `list-webhooks`                  | List webhook subscriptions configured for the shop.                          | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/list-webhooks.ts)                  |
| `publish-review`                 | Publish (show) a previously hidden review.                                   | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/publish-review.ts)                 |
| `reply-to-review`                | Post a public reply to a review, shown on the storefront widget.             | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/reply-to-review.ts)                |
| `resolve-product-by-external-id` | Resolve a platform product id to the internal Judge.me product id.           | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/resolve-product-by-external-id.ts) |
| `send-manual-review-request`     | Send a manual review request email for an order.                             | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/send-manual-review-request.ts)     |
| `send-private-review-reply`      | Send a private email reply to a reviewer instead of posting publicly.        | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/send-private-review-reply.ts)      |
| `unpublish-review`               | Hide a published review from the storefront.                                 | [Action](/docs/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/actions/unpublish-review.ts)               |
| `orders`                         | Sync orders known to Judge.me for the shop.                                  | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/syncs/orders.ts)                           |
| `products`                       | Sync all products known to Judge.me for the shop.                            | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/syncs/products.ts)                         |
| `reviews`                        | Sync all reviews for the shop.                                               | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/judgeme-oauth/syncs/reviews.ts)                          |

***
