📰Feed Data

When a restock event occurs, the WebSocket server will send a message in the following format:

When authenticating with Flow, the mandatory app parameter plays a crucial role in tailoring your feed data. By providing your app's details, Flow intelligently filters the data, ensuring you receive only the information that is relevant to your application. This personalized approach allows for seamless integration, providing you with precise and focused results. Enjoy an optimized experience with app-specific filtering in Flow's feed data.

{
  "type": "feed",
  "data": {
    "platform": "**[PLATFORM NAME]**",
    "name": "**[SITE NAME]**",
    "locale": "**[COUNTRY CODE]**",
    "siteOrigin": "**[SITE URL]**",
    "status": "**[RESTOCK STATUS]**",
    "time": "**[TIMESTAMP]**",
    "tags": [
      ...
    ],
    "products": [
      {
        "id": "**[PRODUCT ID]**",
        "title": "**[PRODUCT NAME]**",
        "sku": "**[SKU]**",
        "price": "**[PRODUCT PRICE]**",
        "ogprice": "**[ORIGINAL PRODUCT PRICE]**",
        "currency": "**[CURRENCY CODE]**",
        "url": "**[PRODUCT URL]**",
        "image": "**[PRODUCT IMAGE URL]**",
        "filtered": "**[PRODUCT FILTERED STATUS]**",
        "sizes": [
          {
            "id": "**[SIZE ID]**",
            "title": "**[SIZE TITLE]**"
          },
          ...
        ]
      },
      ...
    ]
  }
}

Field	Type	Description
platform	string	The name of the platform where the restock occurred.
name	string	The name of the site where the restock occurred.
locale	string	The country code of the site where the restock occurred.
siteOrigin	string	The URL of the site where the restock occurred.
status	string	The status of the restock, such as Shopify Checkpoint up.
time	number	The timestamp of the restock occurrence in milliseconds.
tags	array	An array of strings containing tags specific to the ping, providing useful information.
products	array	An array of restocked products.
products.id	string	The ID of the restocked product.
products.title	string	The name of the restocked product.
products.sku	string	The SKU of the restocked product.
products.price	number	The current price of the restocked product.
products.ogprice	number	The original price of the restocked product.
products.currency	string	The currency code for the price, e.g., "USD".
products.url	string	The URL of the restocked product page.
products.image	string	The URL of the restocked product image.
products.filtered	boolean	Specifies whether the product has been flagged as filtered in the client based on keyword matches.
products.sizes	array	An array of available sizes for the product.
products.sizes.id	string	The ID of the size for the restocked product.
products.sizes.title	string	The name of the size for the restocked product.