Webhooks
Product Deleted Event

Webhook Event: Product Deleted

Event Name: product_deleted
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 a product is deleted from the store. The webhook payload provides the identifier of the deleted product, allowing the store to update its records accordingly.

Payload Structure

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

  • event_name (string): The name of the webhook event, in this case, product_deleted.
  • is_test (boolean): Indicates if the webhook event is a test.
  • id (string): The unique identifier for the product that was deleted.
  • store_id (string): The identifier of the store from which the product was deleted.

Example Payload

{
  "event_name": "product_deleted",
  "is_test": false,
  "id": "prod456",
  "store_id": "store789"
}

Handling the Event

Upon receiving a product_deleted webhook, remove the corresponding product from your system to ensure it no longer appears as available. The is_test key allows for differentiation between actual deletions and test events.