> Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

---
title: "Events"
description: "This page documents all webhooks sent by Rye. You can view JSON schemas for the webhooks below at [this link](https://gist.github.com/amey-rye/4853842d039db75e0a1ae238b4a21722)."
---

## Webhook taxonomy

### Payment related webhooks

<Info>
  The `PAYMENT_REFUNDED` webhook is fired when the order is fully refunded.
</Info>

<Tabs items={["PaymentSucceededWebhook", "PaymentFailedWebhook", "PaymentRefundedWebhook"]}>
  <Tab title="PaymentSucceededWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:00Z",
      "type": "PAYMENT_SUCCEEDED",
      "data": {
        "marketplace": "shopify",
        "amount": 100
      }
    }
    ```
  </Tab>

  <Tab title="PaymentFailedWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_890",
      "createdAt": "2023-06-27T12:00:01Z",
      "type": "PAYMENT_FAILED",
      "data": {
        "marketplace": "shopify"
      }
    }
    ```
  </Tab>

  <Tab title="PaymentRefundedWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_901",
      "createdAt": "2023-06-27T12:00:02Z",
      "type": "PAYMENT_REFUNDED",
      "data": {}
    }
    ```
  </Tab>
</Tabs>

### Refund webhooks

<Info>
  The `REFUND_CREATED` webhook is currently only available for Shopify orders purchased through the Sell Anything API.
</Info>

<Tabs items={["RefundCreatedWebhook"]}>
  <Tab title="RefundCreatedWebhook">
    ```json
    {
      "id": "e7ef85ce-fd45-44e6-9321-e36264b1045c",
      "requestId": "a59cf8dd-9eb7-4ff2-8098-d78e275c2994",
      "developerId": "developer_123",
      "createdAt": "2025-04-03T21:35:22.470Z",
      "type": "REFUND_CREATED",
      "data": {
        // The amount of the refund
        "amount": {
          "currency": "USD",
          // A human readable representation of the amount.
          "displayValue": "$10.50",
          // In currency base units.
          // This represents US$10.50.
          "value": 1050
        }
      }
    }
    ```
  </Tab>
</Tabs>

### Product related webhooks

<Warning>
  **Note**: You should interpret the `PRODUCT_UPDATED` webhook as an upsert, as Rye currently does not send a separate event for when products are first created inside our system. This behavior is likely to change in future, as firing a separate `PRODUCT_CREATED` event is on our roadmap.
</Warning>

Product related webhooks are fired when our product catalog is updated. Subscriptions are created for your account when you request a product or store to be tracked by the [Sell Anything API](/sell-anything-api-overview).

The `product` field in the webhook payload comes in a similar format to the response of the [`productByID`](/api-reference/productbyid) query.

<Tabs items={["ProductUpdatedWebhook (Amazon)", "ProductUpdatedWebhook (Shopify)", "ProductDeletedWebhook (Amazon)", "ProductDeletedWebhook (Shopify)"]}>
  <Tab title="ProductUpdatedWebhook (Amazon)">
    ```json
    {
      "id": "ffd4ee63-b911-48a2-84fe-8ba445746b0b",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2024-03-22T23:57:48.009Z",
      "type": "PRODUCT_UPDATED",
      "marketplace": "amazon",
      "data": {
        "product": {
          "id": "B00A2KD8NY",
          "title": "OXO Good Grips 3-in-1 Egg Separator, White/Yellow 1 Count (Pack of 1)",
          "url": "https://www.amazon.com/OXO-Good-Grips-Separator-White/dp/B00A2KD8NY",
          "vendor": "OXO",
          // ...
        }
      }
    }
    ```
  </Tab>

  <Tab title="ProductUpdatedWebhook (Shopify)">
    ```json
    {
      "id": "34c90daf-4934-4957-ad9d-6ec165dc1e76",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2024-03-22T23:57:48.009Z",
      "type": "PRODUCT_UPDATED",
      "marketplace": "shopify",
      "data": {
        "product": {
          "id": "6552203755571",
          "title": "Rowena Sequin Mermaid Dress",
          "url": "/products/rowena-sequin-mermaid-dress-050021512049",
          "storeCanonicalURL": "https://www.windsorstore.com",
          "vendor": "Windsor",
          // ...
        }
      }
    }
    ```
  </Tab>

  <Tab title="ProductDeletedWebhook (Amazon)">
    ```json
    {
      "id": "ffd4ee63-b911-48a2-84fe-8ba445746b0b",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2025-03-26T23:57:48.009Z",
      "type": "PRODUCT_DELETED",
      "marketplace": "amazon",
      "data": {
        "product": {
          "id": "B00A2KD8NY"
        }
      }
    }
    ```
  </Tab>

  <Tab title="ProductDeletedWebhook (Shopify)">
    ```json
    {
      "id": "34c90daf-4934-4957-ad9d-6ec165dc1e76",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2025-03-26T23:57:48.009Z",
      "type": "PRODUCT_DELETED",
      "marketplace": "shopify",
      "data": {
        "product": {
          "id": "6552203755571",
          "storeDomain": "storedomain.myshopify.com"
        }
      }
    }
    ```
  </Tab>
</Tabs>

### Order submission related webhooks

<Tabs items={["OrderSubmissionStartedWebhook", "OrderSubmissionSucceededWebhook"]}>
  <Tab title="OrderSubmissionStartedWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:03Z",
      "type": "ORDER_SUBMISSION_STARTED",
      "data": {
        "marketplace": "shopify"
      }
    }
    ```
  </Tab>

  <Tab title="OrderSubmissionSucceededWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_123",
      "createdAt": "2023-06-27T12:00:04Z",
      "type": "ORDER_SUBMISSION_SUCCEEDED",
      "data": {
        "marketplace": "shopify"
      }
    }
    ```
  </Tab>
</Tabs>

### Order cancellation related webhooks (Amazon)

<Tabs items={["OrderCancelStartedWebhook", "OrderCancelSucceededWebhook", "OrderCancelFailedWebhook"]}>
  <Tab title="OrderCancelStartedWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:03Z",
      "type": "ORDER_CANCEL_STARTED",
      "data": {
        "marketplace": "amazon",
        "startedAt": "2023-09-07T17:49:07.267Z"
      }
    }
    ```
  </Tab>

  <Tab title="OrderCancelSucceededWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_123",
      "createdAt": "2023-06-27T12:00:04Z",
      "type": "ORDER_CANCEL_SUCCEEDED",
      "data": {
        "marketplace": "amazon",
        "cancelledAt": "2023-09-07T17:49:07.267Z"
      }
    }
    ```
  </Tab>

  <Tab title="OrderCancelFailedWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_123",
      "createdAt": "2023-06-27T12:00:04Z",
      "type": "ORDER_CANCEL_FAILED",
      "data": {
        "marketplace": "amazon",
        "reason": "Order already shipped"
      }
    }
    ```
  </Tab>
</Tabs>

### Order placed and failure related webhooks

<Tabs items={["OrderPlacedWebhook (Shopify)", "OrderPlacedWebhook (Amazon)", "OrderFailedWebhook"]}>
  <Tab title="OrderPlacedWebhook (Shopify)">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:06Z",
      "type": "ORDER_PLACED",
      "data": {
        "marketplace": "shopify",
        "order": {
          "currency": "USD",
          "shippingCents": 500,
          "subtotalCents": 2000,
          "taxCents": 200,
          "totalCents": 2700,
        },
        "orderEmailOverride": "email-override-used@rye.com"
      }
    }
    ```
  </Tab>

  <Tab title="OrderPlacedWebhook (Amazon)">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:05Z",
      "type": "ORDER_PLACED",
      "data": {
        "marketplace": "amazon",
        "order": {
          "currency": "USD",
          "shippingCents": 500,
          "subtotalCents": 2000,
          "taxCents": 200,
          "totalCents": 2700,
          "amazonOrders": [
            {
              "amazonOrderId": "113-7953074923-1301",
              "products": [
                {
                  "quantity": 2,
                  "productId": "B09X7FXHVJ"
                },
                {
                  "quantity": 1,
                  "productId": "B09X7CFXSX"
                }
              ]
            }
          ]
        }
      }
    }
    ```
  </Tab>

  <Tab title="OrderFailedWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:07Z",
      "type": "ORDER_FAILED",
      "data": {
        "marketplace": "amazon",
        "refund": {
          "amount": 1000,
          "created": 1675936800,
          "currency": "USD",
          "receipt_number": "refund_593203912",
          "status": "succeeded"
        },
        "reasonCode": "INTERNAL_ERROR",
        "reason": "An internal error occurred."
      }
    }
    ```
  </Tab>
</Tabs>

### Order requires action webhooks

<Tabs items={["OrderRequiresActionWebhook"]}>
  <Tab title="OrderRequiresActionWebhook">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:06Z",
      "type": "ORDER_REQUIRES_ACTION",
      "data": {
        "order": {
          "requiredActions": {
            "CompletePaymentChallenge": {
              "redirectURL": "https://hooks.stripe.com/redirect/authenticate/src_1OZJBQHGDlstla3f4WO2gYDJ?client_secret=src_client_secret_dRbH7vMWvHpueFHzo8ZDpMdo&source_redirect_slug=test_YWNjdF8xTGdEaHJIR0Rsc3RsYTNmLF9QTzVNNGlGdzNyenlMZHRXeDduVnE3bDh2ZGp2TEdS0100HDag50jR",
              "type": "CompletePaymentChallenge",
            },
          }
        },
      }
    }
    ```
  </Tab>
</Tabs>

### Tracking related webhooks

<Note>
  List of possible shipping carriers can be found [here](/shippingcarriers).
</Note>

<Tabs items={["TrackingObtainedWebhook (Shopify)", "TrackingObtainedWebhook (Amazon)", "OrderDeliveredWebhook (Amazon)", "OrderDeliveryDelayedWebhook (Amazon)"]}>
  <Tab title="TrackingObtainedWebhook (Shopify)">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "TRACKING_OBTAINED",
      "data": {
        "marketplace": "shopify",
        "order": {
          "fulfillments": [
            {
              "products": [
                {
                  "quantity": 1,
                  "variantId": "41160207204557"
                }
              ],
              "trackingDetails": [
                {
                  "trackingNumber": "1Z87F765679738",
                  "courierUrl": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z87F765679738",
                  "courierName": "UPS"
                }
              ]
            }
          ]
        }
      }
    }
    ```
  </Tab>

  <Tab title="TrackingObtainedWebhook (Amazon)">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_567",
      "createdAt": "2023-06-27T12:00:08Z",
      "type": "TRACKING_OBTAINED",
      "data": {
        "marketplace": "amazon",
        "order": {
          "amazonOrders": [
            {
              "amazonOrderId": "113-7953074923-1301",
              "products": [
                {
                  "quantity": 1,
                  "productId": "B09X7FXHVJ"
                }
              ],
              "shipments": [
                {
                  "carrierName": "USPS",
                  "carrierTracking": "123",
                  "carrierTrackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=123",
                  "deliveryInformation": {
                    "deliveryStatus": "NOT_AVAILABLE",
                    "expectedDeliveryDate": "2025-02-17T06:00:00.000Z"
                  },
                  "shipmentDate": "2025-02-16T16:47:04.000Z",
                  "shipmentQuantity": 1,
                  "shipmentStatus": "SHIPPED"
                }
              ]
            }
          ]
        }
      }
    }
    ```
  </Tab>

  <Tab title="OrderDeliveredWebhook (Amazon)">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_567",
      "createdAt": "2023-06-27T12:00:08Z",
      "type": "ORDER_DELIVERED",
      "data": {
        "marketplace": "amazon",
        "shipments": [
          {
            "carrierName": "USPS",
            "carrierTracking": "123",
            "carrierTrackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=123",
            "deliveryInformation": {
              "deliveryStatus": "DELIVERED",
              "expectedDeliveryDate": "Oct 7, 2023, 8:18:59.000 AM"
            },
            "shipmentDate": "Oct 7, 2023, 8:18:59.000 AM",
            "shipmentQuantity": 1,
            "shipmentStatus": "SHIPPED"
          }
        ],
      }
    }
    ```
  </Tab>

  <Tab title="OrderDeliveryDelayedWebhook (Amazon)">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "developer_567",
      "createdAt": "2023-06-27T12:00:08Z",
      "type": "ORDER_DELIVERY_DELAYED",
      "data": {
        "marketplace": "amazon",
        "shipments": [
          {
            "carrierName": "USPS",
            "carrierTracking": "123",
            "carrierTrackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=123",
            "deliveryInformation": {
              "deliveryStatus": "NOT_DELIVERED",
              "expectedDeliveryDate": "Oct 7, 2023, 8:18:59.000 AM"
            },
            "shipmentDate": "Oct 7, 2023, 8:18:59.000 AM",
            "shipmentQuantity": 1,
            "shipmentStatus": "SHIPPED"
          }
        ],
      }
    }
    ```
  </Tab>
</Tabs>

### Returns related webhooks (Shopify Sync API)

<Tabs items={["ReturnRequestedEvent", "ReturnRequestAcceptedEvent", "ReturnApprovedEvent", "ReturnDeniedEvent", "ReturnClosedEvent"]}>
  <Tab title="ReturnRequestedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_REQUESTED",
      "data": {
        "marketplace": "shopify",
        "returnId": "123456",
        "requestedAt": "2023-06-27T12:00:09Z",
        "requestedLineItems": [
          {
            "variantId": "123456"
          }
        ]
      }
    }
    ```
  </Tab>

  <Tab title="ReturnRequestAcceptedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_REQUEST_ACCEPTED",
      "data": {
        "marketplace": "shopify",
        "returnId": "123456",
        "acceptedAt": "2023-06-27T12:00:09Z"
      }
    }
    ```
  </Tab>

  <Tab title="ReturnApprovedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_APPROVED",
      "data": {
        "marketplace": "shopify",
        "returnId": "123456",
        "approvedAt": "2023-06-27T12:00:09Z",
        "shippingLabelUrl": "https://www.example.com/label.pdf",
        "refundAmount": 100,
        "requestedLineItems": [
          {
            "variantId": "123456"
          }
        ]
      }
    }
    ```
  </Tab>

  <Tab title="ReturnDeniedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_DENIED",
      "data": {
        "marketplace": "shopify",
        "returnId": "123456",
        "deniedAt": "2023-06-27T12:00:09Z"
      }
    }
    ```
  </Tab>

  <Tab title="ReturnClosedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_CLOSED",
      "data": {
        "marketplace": "shopify",
        "returnId": "123456",
        "closedAt": "2023-09-07T17:49:07.267Z",
        "refundedLineItems": [
          {
            "variantId": "123456"
          }
        ]
      }
    }
    ```
  </Tab>
</Tabs>

### Returns related webhooks (Amazon)

<Tabs items={["ReturnRequestedEvent", "ReturnRequestAcceptedEvent", "ReturnApprovedEvent", "ReturnDeniedEvent", "ReturnClosedEvent"]}>
  <Tab title="ReturnRequestedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_REQUESTED",
      "data": {
        "marketplace": "amazon",
        "returnId": "123456",
        "requestedAt": "2023-06-27T12:00:09Z",
        "requestedLineItems": [
          {
            "productId": "123456",
            "status": "RETURN_REQUESTED",
          }
        ]
      }
    }
    ```
  </Tab>

  <Tab title="ReturnRequestAcceptedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_REQUEST_ACCEPTED",
      "data": {
        "marketplace": "amazon",
        "returnId": "123456",
        "acceptedAt": "2023-06-27T12:00:09Z"
      }
    }
    ```
  </Tab>

  <Tab title="ReturnApprovedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_APPROVED",
      "data": {
        "marketplace": "amazon",
        "returnId": "123456",
        "approvedAt": "2023-06-27T12:00:09Z",
        "shippingLabelUrl": "https://www.example.com/label.pdf",
        "refundAmount": 100,
        "requestedLineItems": [
          {
            "productId": "123456",
            "status": "RETURN_APPROVED"
          }
        ]
      }
    }
    ```
  </Tab>

  <Tab title="ReturnDeniedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_DENIED",
      "data": {
        "marketplace": "amazon",
        "returnId": "123456",
        "deniedAt": "2023-06-27T12:00:09Z",
        "requestedLineItems": [
          {
            "productId": "123456",
            "status": "RETURN_DENIED"
          }
        ]
      }
    }
    ```
  </Tab>

  <Tab title="ReturnClosedEvent">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "requestId": "d222c412-fbc8-4e59-8cef-b57696bxyz11",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "RETURN_CLOSED",
      "data": {
        "marketplace": "amazon",
        "returnId": "123456",
        "closedAt": "2023-09-07T17:49:07.267Z",
        "refundedLineItems": [
          {
            "productId": "123456",
            "status": "RETURN_CLOSED",
          }
        ]
      }
    }
    ```
  </Tab>
</Tabs>

### Sync API webhooks

If you are integrated with a Shopify merchant, we will send you webhooks when the state of the Rye Shopify app or sales channel changes.

We fire `SHOPIFY_APP_CONNECTED` and `SHOPIFY_APP_DISCONNECTED` events when the Shopify app is installed or uninstalled from the merchant's store.

We also fire events when the set of products published to our sales channel updates:

* `SHOPIFY_PRODUCT_UPDATED` - Fired when the product is published to the Rye sales channel, or when a product published to the Rye sales channel is updated (e.g. the merchant might have changed the product description).
* `SHOPIFY_PRODUCT_DELETED` - Fired when a product is unpublished from the Rye sales channel.

<Tabs items={["ShopifyAppConnected", "ShopifyAppDisconnected", "ShopifyProductUpdated", "ShopifyProductDeleted"]}>
  <Tab title="ShopifyAppConnected">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "SHOPIFY_APP_CONNECTED",
      "data": {
        "shopDomain": "rye.myshopify.com",
      }
    }
    ```
  </Tab>

  <Tab title="ShopifyAppDisconnected">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "SHOPIFY_APP_DISCONNECTED",
      "data": {
        "shopDomain": "rye.myshopify.com"
      }
    }
    ```
  </Tab>

  <Tab title="ShopifyProductUpdated">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "SHOPIFY_PRODUCT_UPDATED",
      "data": {
        "marketplace": "shopify",
        "product": {
          "id": 8086114009390,
          "requestDomain": "rye-dev-store.myshopify.com",
          "title": "Galaxy Buds Pro",
          "handle": "galaxy-buds-pro",
          "description": "Compact earbud, cool!",
          "publishedAt": "2024-02-20T08:11:28-08:00",
          "createdAt": "2023-01-18T11:05:44-08:00",
          "vendor": "rye-dev-store",
          "type": "Earphones",
          "tags": [
            "buds",
            "earphones",
            "samsung"
          ],
          "price": 15000,
          "priceMin": 15000,
          "priceMax": 16000,
          "available": true,
          "priceVaries": true,
          "compareAtPrice": 14000,
          "compareAtPriceMin": 14000,
          "compareAtPriceMax": 14000,
          "compareAtPriceVaries": false,
          "variants": [
            {
              "id": 44358722486574,
              "title": "Black",
              "option1": "Black",
              "sku": "123654789",
              "requiresShipping": true,
              "taxable": true,
              "featuredImage": {
                "id": 40285007610158,
                "createdAt": "2023-01-18T11:05:48-08:00",
                "position": 1,
                "updatedAt": "2023-01-18T11:05:48-08:00",
                "productId": 8086114009390,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748",
                "variantIds": [
                  44358722486574
                ],
                "width": 2560,
                "height": 1707,
                "alt": "Black"
              },
              "available": true,
              "name": "Galaxy Buds Pro - Black",
              "publicTitle": "Black",
              "options": [
                "Black"
              ],
              "price": 15100,
              "weight": 90,
              "compareAtPrice": 14000,
              "inventoryQuantity": 301,
              "inventoryManagement": "shopify",
              "inventoryPolicy": "deny",
              "barcode": "ISBN=AA000992123",
              "featuredMedia": {
                "alt": "Black",
                "id": 40285007610158,
                "position": 1,
                "aspectRatio": 1,
                "height": 1707,
                "width": 2560,
                "mediaType": "image",
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748",
                "previewImage": {
                  "aspectRatio": 1,
                  "height": 1707,
                  "width": 2560,
                  "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748"
                }
              },
              "requiresSellingPlan": false,
              "sellingPlanAllocations": []
            },
            {
              "id": 44358722584878,
              "title": "Purple",
              "option1": "Purple",
              "sku": "123654790",
              "requiresShipping": true,
              "taxable": true,
              "featuredImage": {
                "id": 40285009183022,
                "createdAt": "2023-01-18T11:05:51-08:00",
                "position": 2,
                "updatedAt": "2023-01-18T11:05:51-08:00",
                "productId": 8086114009390,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/uk-galaxy-buds-pro-r190-sm-r190nzvaeua-363855690.png?v=1674068751",
                "variantIds": [
                  44358722584878
                ],
                "width": 650,
                "height": 519,
                "alt": "Purple"
              },
              "available": true,
              "name": "Galaxy Buds Pro - Purple",
              "publicTitle": "Purple",
              "options": [
                "Purple"
              ],
              "price": 16000,
              "weight": 70,
              "compareAtPrice": 14000,
              "inventoryQuantity": 329,
              "inventoryManagement": "shopify",
              "inventoryPolicy": "deny",
              "barcode": "",
              "featuredMedia": {
                "alt": "Purple",
                "id": 40285009183022,
                "position": 1,
                "aspectRatio": 1,
                "height": 519,
                "width": 650,
                "mediaType": "image",
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/uk-galaxy-buds-pro-r190-sm-r190nzvaeua-363855690.png?v=1674068751",
                "previewImage": {
                  "aspectRatio": 1,
                  "height": 519,
                  "width": 650,
                  "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/uk-galaxy-buds-pro-r190-sm-r190nzvaeua-363855690.png?v=1674068751"
                }
              },
              "requiresSellingPlan": false,
              "sellingPlanAllocations": []
            },
            {
              "id": 44358722650414,
              "title": "White",
              "option1": "White",
              "sku": "123654791",
              "requiresShipping": true,
              "taxable": true,
              "featuredImage": {
                "id": 40285008232750,
                "createdAt": "2023-01-18T11:05:50-08:00",
                "position": 3,
                "updatedAt": "2023-01-18T11:05:51-08:00",
                "productId": 8086114009390,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/sa-en-galaxy-buds-pro-r190-367517-sm-r190nzsaksa-367054549.png?v=1674068751",
                "variantIds": [
                  44358722650414
                ],
                "width": 650,
                "height": 519,
                "alt": "White"
              },
              "available": true,
              "name": "Galaxy Buds Pro - White",
              "publicTitle": "White",
              "options": [
                "White"
              ],
              "price": 15000,
              "weight": 70,
              "compareAtPrice": 14000,
              "inventoryQuantity": 331,
              "inventoryManagement": "shopify",
              "inventoryPolicy": "deny",
              "barcode": "",
              "featuredMedia": {
                "alt": "White",
                "id": 40285008232750,
                "position": 1,
                "aspectRatio": 1,
                "height": 519,
                "width": 650,
                "mediaType": "image",
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/sa-en-galaxy-buds-pro-r190-367517-sm-r190nzsaksa-367054549.png?v=1674068751",
                "previewImage": {
                  "aspectRatio": 1,
                  "height": 519,
                  "width": 650,
                  "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/sa-en-galaxy-buds-pro-r190-367517-sm-r190nzsaksa-367054549.png?v=1674068751"
                }
              },
              "requiresSellingPlan": false,
              "sellingPlanAllocations": []
            }
          ],
          "images": [
            "//cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748",
            "//cdn.shopify.com/s/files/1/0670/1442/6926/products/uk-galaxy-buds-pro-r190-sm-r190nzvaeua-363855690.png?v=1674068751",
            "//cdn.shopify.com/s/files/1/0670/1442/6926/products/sa-en-galaxy-buds-pro-r190-367517-sm-r190nzsaksa-367054549.png?v=1674068751",
            "//cdn.shopify.com/s/files/1/0670/1442/6926/products/783ff8f7-b725-4710-b52f-5e2fbe66fe3f.a30cccac57e4db72c4fcff2250dcf0de.png?v=1674068751",
            "//cdn.shopify.com/s/files/1/0670/1442/6926/products/3a7244c3-55de-11eb-aeee-4763e14b6243.jpg?v=1674068751"
          ],
          "featuredImage": "//cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748",
          "options": [
            {
              "id": 10267632927022,
              "name": "Color",
              "productId": 8086114009390,
              "position": 1,
              "values": [
                "Black",
                "Purple",
                "White"
              ]
            }
          ],
          "storeCanonicalUrl": "https://rye-dev-store.myshopify.com",
          "url": "/products/galaxy-buds-pro",
          "dateUpdated": "Wed, 13 Mar 2024 16:09:19 GMT",
          "currencyCode": "USD",
          "media": [
            {
              "alt": "Galaxy Buds Pro",
              "id": 40285007610158,
              "position": 1,
              "aspectRatio": 1,
              "height": 1707,
              "mediaType": "image",
              "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748",
              "width": 2560,
              "previewImage": {
                "aspectRatio": 1,
                "height": 1707,
                "width": 2560,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/719p0eyZiSL.jpg?v=1674068748"
              }
            },
            {
              "alt": "Galaxy Buds Pro",
              "id": 40285009183022,
              "position": 2,
              "aspectRatio": 1,
              "height": 519,
              "mediaType": "image",
              "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/uk-galaxy-buds-pro-r190-sm-r190nzvaeua-363855690.png?v=1674068751",
              "width": 650,
              "previewImage": {
                "aspectRatio": 1,
                "height": 519,
                "width": 650,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/uk-galaxy-buds-pro-r190-sm-r190nzvaeua-363855690.png?v=1674068751"
              }
            },
            {
              "alt": "Galaxy Buds Pro",
              "id": 40285008232750,
              "position": 3,
              "aspectRatio": 1,
              "height": 519,
              "mediaType": "image",
              "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/sa-en-galaxy-buds-pro-r190-367517-sm-r190nzsaksa-367054549.png?v=1674068751",
              "width": 650,
              "previewImage": {
                "aspectRatio": 1,
                "height": 519,
                "width": 650,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/sa-en-galaxy-buds-pro-r190-367517-sm-r190nzsaksa-367054549.png?v=1674068751"
              }
            },
            {
              "alt": "Galaxy Buds Pro",
              "id": 40285007675694,
              "position": 4,
              "aspectRatio": 1,
              "height": 612,
              "mediaType": "image",
              "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/783ff8f7-b725-4710-b52f-5e2fbe66fe3f.a30cccac57e4db72c4fcff2250dcf0de.png?v=1674068751",
              "width": 612,
              "previewImage": {
                "aspectRatio": 1,
                "height": 612,
                "width": 612,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/783ff8f7-b725-4710-b52f-5e2fbe66fe3f.a30cccac57e4db72c4fcff2250dcf0de.png?v=1674068751"
              }
            },
            {
              "alt": "Galaxy Buds Pro",
              "id": 40285007577390,
              "position": 5,
              "aspectRatio": 1,
              "height": 1030,
              "mediaType": "image",
              "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/3a7244c3-55de-11eb-aeee-4763e14b6243.jpg?v=1674068751",
              "width": 1600,
              "previewImage": {
                "aspectRatio": 1,
                "height": 1030,
                "width": 1600,
                "src": "https://cdn.shopify.com/s/files/1/0670/1442/6926/products/3a7244c3-55de-11eb-aeee-4763e14b6243.jpg?v=1674068751"
              }
            }
          ],
          "requiresSellingPlan": false,
          "sellingPlanGroups": []
        }
      }
    }
    ```
  </Tab>

  <Tab title="ShopifyProductDeleted">
    ```json
    {
      "id": "hg9b8xyc-a128-4659-9c84-e3b376607977",
      "developerId": "xDasf23Jk4LKlxOq",
      "createdAt": "2023-06-27T12:00:09Z",
      "type": "SHOPIFY_PRODUCT_DELETED",
      "data": {
        "marketplace": "shopify",
        "productId": "8086114009390"
      }
    }
    ```
  </Tab>
</Tabs>

### Affiliate Related Webhooks

<Tabs items={["ExperimentalAffiliateCommissionPending", "ExperimentalAffiliateCommissionUnconfirmed", "ExperimentalAffiliateCommissionConfirmed", "ExperimentalAffiliateCommissionUpdated", "ExperimentalAffiliateCommissionFinalized"]}>
  <Tab title="ExperimentalAffiliateCommissionPending">
    ```json
    {
      "type": "EXPERIMENTAL_ORDER_AFFILIATE_COMMISSION_UPDATED",
      "developerId": "xDasf23Jk4LKlxOq",
      "requestId": "123e4567-e89b-12d3-a456-426614174000",
      "data": {
        "commission": {
          "__typename": "ExperimentalAffiliateCommissionPending",
          "updatedAt": "2024-08-27T12:00:00Z"
        }
      }
    }
    ```
  </Tab>

  <Tab title="ExperimentalAffiliateCommissionUnconfirmed">
    ```json
    {
      "type": "EXPERIMENTAL_ORDER_AFFILIATE_COMMISSION_UPDATED",
      "developerId": "xDasf23Jk4LKlxOq",
      "requestId": "987e6543-e89b-12d3-a456-426614174111",
      "data": {
        "commission": {
          "__typename": "ExperimentalAffiliateCommissionUnconfirmed",
          "updatedAt": "2024-08-27T12:00:00Z"
        }
      }
    }
    ```
  </Tab>

  <Tab title="ExperimentalAffiliateCommissionConfirmed">
    ```json
    {
      "type": "EXPERIMENTAL_ORDER_AFFILIATE_COMMISSION_UPDATED",
      "developerId": "xDasf23Jk4LKlxOq",
      "requestId": "456e1234-e89b-12d3-a456-426614174222",
      "data": {
        "commission": {
          "__typename": "ExperimentalAffiliateCommissionConfirmed",
          "commissionAmount": {
            "amount": 2000,
            "currency": "USD"
          },
          "orderAmount": {
            "amount": 10000,
            "currency": "USD"
          },
          "updatedAt": "2024-08-27T12:00:00Z"
        }
      }
    }
    ```
  </Tab>

  <Tab title="ExperimentalAffiliateCommissionUpdated">
    ```json
    {
      "type": "EXPERIMENTAL_ORDER_AFFILIATE_COMMISSION_UPDATED",
      "developerId": "xDasf23Jk4LKlxOq",
      "requestId": "321e6543-e89b-12d3-a456-426614174333",
      "data": {
        "commission": {
          "__typename": "ExperimentalAffiliateCommissionUpdated",
          "commissionAmount": {
            "amount": 1800,
            "currency": "EUR"
          },
          "orderAmount": {
            "amount": 9000,
            "currency": "EUR"
          },
          "updatedAt": "2024-08-27T12:00:00Z"
        }
      }
    }
    ```
  </Tab>

  <Tab title="ExperimentalAffiliateCommissionFinalized">
    ```json
    {
      "type": "EXPERIMENTAL_ORDER_AFFILIATE_COMMISSION_UPDATED",
      "developerId": "xDasf23Jk4LKlxOq",
      "requestId": "789e1234-e89b-12d3-a456-426614174444",
      "data": {
        "commission": {
          "__typename": "ExperimentalAffiliateCommissionFinalized",
          "commissionAmount": {
            "amount": 2800,
            "currency": "GBP"
          },
          "orderAmount": {
            "amount": 14000,
            "currency": "GBP"
          },
          "updatedAt": "2024-08-27T12:00:00Z"
        }
      }
    }
    ```
  </Tab>
</Tabs>


---

*Powered by [holocron.so](https://holocron.so)*