From 2f4d659854cb1fdcbf0d857ee95208957f8b2f28 Mon Sep 17 00:00:00 2001 From: Kevin O'Sullivan Date: Thu, 8 Dec 2022 11:55:32 -0500 Subject: [PATCH] Add apiVersion to webhooks docs --- docs/usage/webhooks.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/usage/webhooks.md b/docs/usage/webhooks.md index d2dab1ca4..4d2bf926b 100644 --- a/docs/usage/webhooks.md +++ b/docs/usage/webhooks.md @@ -27,6 +27,7 @@ const handleWebhookRequest = async ( shop: string, webhookRequestBody: string, webhookId: string, + apiVersion: string, ) => { // handler triggered when a webhook is sent by the Shopify platform to your application }; @@ -68,12 +69,13 @@ This method accepts an object indexed by topic. Each topic can map to an object When a shop triggers an event you subscribed to, the `process` method [below](#webhook-processing) will call your `Http` callbacks with the following arguments: -| Parameter | Type | Notes | -| -------------------- | -------- | ------------------------------------------------ | -| `topic` | `string` | The webhook topic. | -| `shop` | `string` | The shop for which the webhook was triggered. | -| `webhookRequestBody` | `string` | The payload of the POST request made by Shopify. | -| `webhookId` | `string` | The id of the webhook registration in Shopify. | +| Parameter | Type | Notes | +| --------------------- | -------- | ------------------------------------------------ | +| `topic` | `string` | The webhook topic. | +| `shop` | `string` | The shop for which the webhook was triggered. | +| `webhookRequestBody` | `string` | The payload of the POST request made by Shopify. | +| `webhookId` | `string` | The id of the webhook registration in Shopify. | +| `apiVersion` | `string` | The apiVersion of the webhook. | ## Get webhook registry information