---
title: Webhook
description: Contains functions for verifying Shopify webhooks.
api_version: v3
api_name: shopify-app-remix
source_url:
  html: 'https://shopify.dev/docs/api/shopify-app-remix/v3/authenticate/webhook'
  md: 'https://shopify.dev/docs/api/shopify-app-remix/v3/authenticate/webhook.md'
---

# Webhook

Contains functions for verifying Shopify webhooks.

## authenticate.​webhook([request](#authenticatewebhook-propertydetail-request)​)

Verifies requests coming from Shopify webhooks.

### Parameters

* request

  Request

  required

### Returns

* Promise\<WebhookContext\<ConfigArg, Resources, Topics>>

### WebhookContext

```ts
WebhookContextWithoutSession<Topics> | WebhookContextWithSession<ConfigArg, Resources, Topics>
```

### WebhookContextWithoutSession

* admin

  ```ts
  undefined
  ```

* apiVersion

  The API version used for the webhook.

  ```ts
  string
  ```

* payload

  The payload from the webhook request.

  ```ts
  Record<string, any>
  ```

* session

  ```ts
  undefined
  ```

* shop

  The shop where the webhook was triggered.

  ```ts
  string
  ```

* subTopic

  The sub-topic of the webhook. This is only available for certain webhooks.

  ```ts
  string
  ```

* topic

  The topic of the webhook.

  ```ts
  Topics
  ```

* webhookId

  A unique ID for the webhook. Useful to keep track of which events your app has already processed.

  ```ts
  string
  ```

```ts
export interface WebhookContextWithoutSession<Topics = string | number | symbol>
  extends Context<Topics> {
  session: undefined;
  admin: undefined;
}
```

### WebhookContextWithSession

* admin

  An admin context for the webhook. Returned only if there is a session for the shop.

  ```ts
  AdminApiContext<ConfigArg, Resources>
  ```

* apiVersion

  The API version used for the webhook.

  ```ts
  string
  ```

* payload

  The payload from the webhook request.

  ```ts
  Record<string, any>
  ```

* session

  A session with an offline token for the shop. Returned only if there is a session for the shop. Webhook requests can trigger after an app is uninstalled If the app is already uninstalled, the session may be undefined. Therefore, you should check for the session before using it.

  ```ts
  Session
  ```

* shop

  The shop where the webhook was triggered.

  ```ts
  string
  ```

* subTopic

  The sub-topic of the webhook. This is only available for certain webhooks.

  ```ts
  string
  ```

* topic

  The topic of the webhook.

  ```ts
  Topics
  ```

* webhookId

  A unique ID for the webhook. Useful to keep track of which events your app has already processed.

  ```ts
  string
  ```

````ts
export interface WebhookContextWithSession<
  ConfigArg extends AppConfigArg,
  Resources extends ShopifyRestResources,
  Topics = string | number | symbol,
> extends Context<Topics> {
  /**
   * A session with an offline token for the shop.
   *
   * Returned only if there is a session for the shop.
   * Webhook requests can trigger after an app is uninstalled
   * If the app is already uninstalled, the session may be undefined.
   * Therefore, you should check for the session before using it.
   *
   * @example
   * <caption>Protecting against uninstalled apps.</caption>
   * ```ts
   * // /app/routes/webhooks.tsx
   * import type { ActionFunctionArgs } from "@remix-run/node";
   * import { authenticate } from "~/shopify.server";

   * export const action = async ({ request }: ActionFunctionArgs) => {
   *   const { session } = await authenticate.webhook(request);
   *   
   *   // Webhook requests can trigger after an app is uninstalled
   *   // If the app is already uninstalled, the session may be undefined.
   *   if (!session) {
   *     throw new Response();
   *   }
   *
   *   // Handle webhook request
   *   console.log("Received webhook webhook");
   *
   *   return new Response();
   * };
   * ```
   */
  session: Session;

  /**
   * An admin context for the webhook.
   *
   * Returned only if there is a session for the shop.
   *
   * @example
   * <caption>Webhook admin context.</caption>
   * <description>Use the `admin` object in the context to interact with the Admin API.</description>
   * ```ts
   * // /app/routes/webhooks.tsx
   * import { ActionFunctionArgs } from "@remix-run/node";
   * import { authenticate } from "../shopify.server";
   *
   * export async function action({ request }: ActionFunctionArgs) {
   *   const { admin } = await authenticate.webhook(request);
   *
   *   // Webhook requests can trigger after an app is uninstalled
   *   // If the app is already uninstalled, the session may be undefined.
   *   if (!session) {
   *     throw new Response();
   *   }
   *
   *   const response = await admin?.graphql(
   *     `#graphql
   *     mutation populateProduct($input: ProductInput!) {
   *       productCreate(input: $input) {
   *         product {
   *           id
   *         }
   *       }
   *     }`,
   *     { variables: { input: { title: "Product Name" } } }
   *   );
   *
   *   const productData = await response.json();
   *   return json({ data: productData.data });
   * }
   * ```
   */
  admin: AdminApiContext<ConfigArg, Resources>;
}
````

Examples

### Examples

* #### Update a metafield when a product is updated

  ##### Description

  Update a metafield when a product is updated

  ##### /app/routes/\*\*.ts

  ```typescript
  import {type ActionFunctionArgs} from '@remix-run/node';

  import {authenticate} from '../shopify.server';

  export const action = async ({request}: ActionFunctionArgs) => {
    const {topic, admin, payload, session} = await authenticate.webhook(request);

    // Webhook requests can trigger after an app is uninstalled
    // If the app is already uninstalled, the session may be undefined.
    if (!session) {
      throw new Response();
    }

    switch (topic) {
      case 'PRODUCTS_UPDATE':
        await admin.graphql(
          `#graphql
          mutation setMetafield($productId: ID!, $time: String!) {
            metafieldsSet(metafields: {
              ownerId: $productId
              namespace: "my-app",
              key: "webhook_received_at",
              value: $time,
              type: "string",
            }) {
              metafields {
                key
                value
              }
            }
          }
        `,
        {
          variables: {
            productId: payload.admin_graphql_api_id,
            time: new Date().toISOString(),
          },
        },
      );
    }

    return new Response();
  };
  ```

* #### Webhook admin context

  ##### Description

  Use the \`admin\` object in the context to interact with the Admin API.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export async function action({ request }: ActionFunctionArgs) {
    const { admin } = await authenticate.webhook(request);

    // Webhook requests can trigger after an app is uninstalled
    // If the app is already uninstalled, the session may be undefined.
    if (!session) {
      throw new Response();
    }

    const response = await admin?.graphql(
      `#graphql
      mutation populateProduct($input: ProductInput!) {
        productCreate(input: $input) {
          product {
            id
          }
        }
      }`,
      { variables: { input: { title: "Product Name" } } }
    );

    const productData = await response.json();
    return json({ data: productData.data });
  }
  ```

* #### Webhook API version

  ##### Description

  Get the API version used for webhook request.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { apiVersion } = await authenticate.webhook(request);
    return new Response();
  };
  ```

* #### Webhook payload

  ##### Description

  Get the request's POST payload.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { payload } = await authenticate.webhook(request);
    return new Response();
  };
  ```

* #### Protecting against uninstalled apps

  ##### /app/routes/webhooks.tsx

  ```typescript
  import type { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "~/shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { session } = await authenticate.webhook(request);
    
    // Webhook requests can trigger after an app is uninstalled
    // If the app is already uninstalled, the session may be undefined.
    if (!session) {
      throw new Response();
    }

    // Handle webhook request
    console.log("Received webhook webhook");

    return new Response();
  };
  ```

* #### Webhook shop

  ##### Description

  Get the shop that triggered a webhook.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { shop } = await authenticate.webhook(request);
    return new Response();
  };
  ```

* #### Webhook sub-topic

  ##### Description

  Get the webhook sub-topic.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { subTopic } = await authenticate.webhook(request);
    return new Response();
  };
  ```

* #### Webhook topic

  ##### Description

  Get the event topic for the webhook.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { topic } = await authenticate.webhook(request);

    switch (topic) {
      case "APP_UNINSTALLED":
        // Do something when the app is uninstalled.
        break;
    }

    return new Response();
  };
  ```

* #### Webhook ID

  ##### Description

  Get the webhook ID.

  ##### /app/routes/webhooks.tsx

  ```typescript
  import { ActionFunctionArgs } from "@remix-run/node";
  import { authenticate } from "../shopify.server";

  export const action = async ({ request }: ActionFunctionArgs) => {
    const { webhookId } = await authenticate.webhook(request);
    return new Response();
  };
  ```

## Related

[Interact with the Admin API. - Admin API context](https://shopify.dev/docs/api/shopify-app-remix/apis/admin-api)