Webhook Event: Store Updated

Event Name: store_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 any information about the store is updated. This includes updates to the store's name, logo, description, or any other detail provided in the store information. The webhook payload reflects the updated store information.

Payload Structure

The webhook payload for the store_updated event includes the following fields, consistent with the store information retrieval API:

• event_name (string): The name of the webhook event, in this case, store_updated.
• is_test (boolean): Indicates if the webhook event is a test.
• created_at (string): The creation date and time of the store record in TIMESTAMPTZ format.
• id (string): The unique identifier for the store.
• name (string): The updated name of the store.
• store_logo_url (string | null): The updated URL to the store's logo image.
• user_id (string): The identifier for the user who owns the store.
• is_active (boolean): Indicates whether the store is currently active or inactive.
• description (string | null): The updated description of the store.
• store_handle (string | null): The updated handle or slug for the store.

Example Payload

{
  "event_name": "store_updated",
  "is_test": false,
  "created_at": "2023-01-01T16:48:32.007852+00",
  "id": "store123",
  "name": "Updated Store Name",
  "store_logo_url": "https://example.com/updated_logo.png",
  "user_id": "user456",
  "is_active": true,
  "description": "Updated description of the store.",
  "store_handle": "updated-store"
}

Handling the Event

Upon receiving a store_updated webhook, update the store information in your system to reflect the changes. This ensures that any displayed store details are current. The is_test key can be used to identify test events during development.