shopify.webhooks.addHandlers

February 15, 2024 · View on GitHub

Adds webhook handlers to the library registry, allowing you to register them with Shopify and process HTTP webhook requests from Shopify.

See the documentation for the full list of accepted topics.

Note: you can only register multiple handlers with the same address when the delivery method is HTTP - the library will automatically chain the requests together when handling events. The library will fail when trying to add duplicate paths for other delivery methods.

Example

const shopify = shopifyApi({
  /* ... */
});

const handleWebhookRequest = async (
  topic: string,
  shop: string,
  webhookRequestBody: string,
  webhookId: string,
  apiVersion: string,
) => {
  const sessionId = shopify.session.getOfflineId(shop);

  // Fetch the session from storage and process the webhook event
};

shopify.webhooks.addHandlers({
  PRODUCTS_CREATE: [
    {
      deliveryMethod: DeliveryMethod.Http,
      callbackUrl: '/webhooks',
      callback: handleWebhookRequest,
    },
    {
      deliveryMethod: DeliveryMethod.Http,
      callbackUrl: '/webhooks',
      callback: handleWebhookRequestPart2,
    },
  ],
});

Parameters

This method accepts an object indexed by topic. Each topic can map to an object or an array of objects with format:

deliveryMethod

DeliveryMethod | :exclamation: required

The delivery method for this handler. Different fields for this object are allowed depending on the method.

includeFields

string[] | Defaults to []

Fields to be included in the callback, defaulting to including all of them.

metafieldNamespaces

string[] | Defaults to []

Namespaces to be included in the callback, defaulting to including all of them.

subTopic

string

Webhook sub-topics are an extra level of grouping available for some webhook topics. See the Shopify documentation for more information, and the list of topics that support sub-topics.