Add subtopics to webhook handlers

Shopify · Jan 31, 2024 · 04ef994 · 04ef994
1 parent 858e69a
commit 04ef994
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/packages/shopify-app-remix/src/server/authenticate/webhooks/authenticate.ts b/packages/shopify-app-remix/src/server/authenticate/webhooks/authenticate.ts
@@ -66,6 +66,7 @@ export function authenticateWebhookFactory<
       topic: check.topic as Topics,
       webhookId: check.webhookId,
       payload: JSON.parse(rawBody),
+      subTopic: check.subTopic || null,
       session: undefined,
       admin: undefined,
     };

diff --git a/packages/shopify-app-remix/src/server/authenticate/webhooks/types.ts b/packages/shopify-app-remix/src/server/authenticate/webhooks/types.ts
@@ -109,6 +109,25 @@ interface Context<Topics = string | number | symbol> {
    * ```
    */
   payload: JSONValue;
+  /**
+   * The sub-topic of the webhook. This is only available for certain webhooks.
+   *
+   * @example
+   * <caption>Webhook sub-topic.</caption>
+   * <description>Get the webhook sub-topic.</description>
+   * ```ts
+   * // /app/routes/webhooks.tsx
+   * import { ActionFunction } from "@remix-run/node";
+   * import { authenticate } from "../shopify.server";
+   *
+   * export const action: ActionFunction = async ({ request }) => {
+   *   const { subTopic } = await authenticate.webhook(request);
+   *   return new Response();
+   * };
+   * ```
+   *
+   */
+  subTopic: string | undefined;
 }
 
 export interface WebhookContextWithoutSession<Topics = string | number | symbol>