Learn how to use Weebly’s webhooks here.

store.info.update

Occurs when the info that appears on invoices for the store is updated.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site whose store was updated.
site_id string ​Site that contains the store.

store.category.create

Occurs when a category is created for a store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
category_id string ​Category that was created.

store.category.delete

Occurs when a category is deleted from a store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
category_id string ​Category that was deleted.

store.category.update

Occurs when a category is updated.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
category_id string ​Category that was updated.

store.product.create

Occurs when a product is created in the store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
product_id string Product that was created.

store.product.update

Occurs when a product is updated in the store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
product_id string Product that was updated.

store.product.delete

Occurs when a product is deleted from the store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
product_id string Product that was deleted.

store.cart.create

Occurs when a customer adds the first product to a cart in the store.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
cart_id string Cart that was created.

store.cart.update

Occurs when a customer adds the additional products to a cart.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
cart_id string Cart that was updated.

store.order.create

Occurs when a customer’s cart is converted to an order.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order that was created.

store.order.update

Occurs when a customer’s order is updated.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order that was updated.

store.order.pay

Occurs when a customer makes a payment for an order.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order associated with the payment.
order_billing_id string The unique billing_id (within the order) for the payment (Weebly defaults to only one).
order_billing_transaction_id string The unique billing_transaction_id (within the order) for the payment.

store.order.refund

Occurs when a customer receives a refund for an order.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order associated with the refund.
order_billing_id string The unique billing_id (within the order) for the refund (Weebly defaults to only one).
order_billing_transaction_id string The unique billing_transaction_id (within the order) for the refund.

store.order.ship

Occurs when an order is shipped.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order that was shipped.
order_shipment_id string The unique shipment_id (within the order) for this shipment (orders can have more than one).
order_shipment_transaction_id string The unique shipment_transaction_id for the shipment.

store.order.return

Occurs when an order is returned.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order that was returned.
order_shipment_id string The unique shipment_id for this shipment return (orders can have more than one).
order_shipment_transaction_id string The unique shipment_transaction_id for the return.

store.order.cancel

Occurs when an order is cancelled.

scope: read:store-orders

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
order_id string Order that was cancelled.

store.coupon.create

Occurs when a coupon is created for a store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
coupon_id string Coupon that was created.

store.coupon.delete

Occurs when a coupon is deleted.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
coupon_id string Coupon that was deleted.

store.coupon.update

Occurs when a coupon is created for a store.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
coupon_id string Coupon that was updated

store.coupon.use

Occurs when a coupon is used in an order.

scope: read:store-catalog

The following table shows the fields that are returned as the data object of the webhook response.

Field Type Definition
user_id string ​User associated with the site that contains the store.
site_id string ​Site that contains the store.
coupon_id string Coupon that was used.
order_id string Order that the coupon that was used on.

Help make these docs better!









Tags:
elements