Webhook Event: Product Updated

Event Name: product_updated
HTTP Method: POST
Webhook URL: Your specified endpoint URL
Test Key: is_test (boolean): Indicates whether the webhook event is a test (true) or a real event (false).

Description

This event is triggered when an existing product's details are updated in the store. The webhook payload includes detailed information about the updated product, reflecting the changes made.

Payload Structure

The webhook payload for the product_updated event includes the following fields:

• event_name (string): The name of the webhook event, in this case, product_updated.
• is_test (boolean): Indicates if the webhook event is a test.
• created_at (string): The creation date and time of the product record in TIMESTAMPTZ format. Reflects the original creation date.
• description (string | null): The updated description of the product.
• id (string): The unique identifier for the product.
• name (string): The updated name of the product.
• store_id (string | null): The identifier of the store this product belongs to.
• image_url (string | null): The updated URL to the product's image.
• status (string): The updated status of the product (active, archived, or hidden).
• quantity_available (number | null): The updated quantity of the product available for sale.
• seller_note (string | null): The updated note from the seller regarding the product.

Example Payload

{
  "event_name": "product_updated",
  "is_test": false,
  "created_at": "2023-01-01T16:48:32.007852+00",
  "description": "Updated product description.",
  "id": "prod456",
  "name": "Updated Product Name",
  "store_id": "store789",
  "image_url": "https://example.com/updated_product.png",
  "status": "active",
  "quantity_available": 95,
  "seller_note": "Updated seller note."
}

Handling the Event

Upon receiving a product_updated webhook, ensure to refresh the product details in your system to reflect the latest information. The is_test key helps in identifying if the webhook is triggered for testing purposes.