Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Commit

Permalink
Add apiVersion to webhooks docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkevinosullivan committed Dec 8, 2022
1 parent c09e7ee commit 2f4d659
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/usage/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
};
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 2f4d659

Please # to comment.