Skip to content

Webhook Event Reference

Webhook Event Reference

EventDescriptionPermissions neededPayload
checkout.customer.before.loginTriggers as soon as a customer logs in-{"email":"string"}
checkout.customer.changed-payment-methodTriggers when a customer changes his payment method in the checkout processcustomer:read{"entity":"customer"}
checkout.customer.deletedTriggers if a customer gets deletedcustomer:read{"entity":"customer"}
checkout.customer.double_opt_in_guest_orderTriggers as soon as double opt-in is accepted in a guest ordercustomer:read{"entity":"customer","confirmUrl":"string"}
checkout.customer.double_opt_in_registrationTriggers when a customer commits to his registration via double opt incustomer:read{"entity":"customer","confirmUrl":"string"}
checkout.customer.guest_registerEMPTYcustomer:read{"entity":"customer"}
checkout.customer.loginTriggers as soon as a customer logs incustomer:read{"entity":"customer","contextToken":"string"}
checkout.customer.logoutTriggers when a customer logs outcustomer:read{"entity":"customer"}
checkout.customer.registerTriggers when a new customer was registeredcustomer:read{"entity":"customer"}
checkout.order.payment_method.changedEMPTYorder:read order_transaction:read{"entity":"order_transaction"}
checkout.order.placedTriggers when an order is placedorder:read{"entity":"order"}
contact_form.sendTriggers when a contact form is send-{"contactFormData":"object"}
customer.group.registration.acceptedEMPTYcustomer:read customer_group:read{"entity":"customer_group"}
customer.group.registration.declinedEMPTYcustomer:read customer_group:read{"entity":"customer_group"}
customer.recovery.requestTriggers when a customer recovers his passwordcustomer_recovery:read customer:read{"entity":"customer","resetUrl":"string","shopName":"string"}
mail.after.create.messageEMPTY-{"data":"array","message":"object"}
mail.before.sendTriggers before a mail is send-{"data":"array","templateData":"array"}
mail.sentTriggers when a mail is send from Shopware-{"subject":"string","contents":"string","recipients":"array"}
newsletter.confirmEMPTYnewsletter_recipient:read{"entity":"newsletter_recipient"}
newsletter.registerEMPTYnewsletter_recipient:read{"entity":"newsletter_recipient","url":"string"}
newsletter.unsubscribeEMPTYnewsletter_recipient:read{"entity":"newsletter_recipient"}
product_export.logEMPTY-{"name":"string"}
review_form.sendTriggers when a product review form is sendproduct:read{"reviewFormData":"object","entity":"product"}
state_enter.order.state.cancelledEMPTYorder:read{"entity":"order"}
state_enter.order.state.completedEMPTYorder:read{"entity":"order"}
state_enter.order.state.in_progressEMPTYorder:read{"entity":"order"}
state_enter.order.state.openEMPTYorder:read{"entity":"order"}
state_enter.order_delivery.state.cancelledEMPTYorder:read{"entity":"order"}
state_enter.order_delivery.state.openEMPTYorder:read{"entity":"order"}
state_enter.order_delivery.state.returnedEMPTYorder:read{"entity":"order"}
state_enter.order_delivery.state.returned_partiallyEMPTYorder:read{"entity":"order"}
state_enter.order_delivery.state.shippedEMPTYorder:read{"entity":"order"}
state_enter.order_delivery.state.shipped_partiallyEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.authorizedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.cancelledEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.chargebackEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.failedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.in_progressEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.openEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.paidEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.paid_partiallyEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.refundedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.refunded_partiallyEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.remindedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction.state.unconfirmedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture.state.completedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture.state.failedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture.state.pendingEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture_refund.state.cancelledEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture_refund.state.completedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture_refund.state.failedEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture_refund.state.in_progressEMPTYorder:read{"entity":"order"}
state_enter.order_transaction_capture_refund.state.openEMPTYorder:read{"entity":"order"}
state_leave.order.state.cancelledEMPTYorder:read{"entity":"order"}
state_leave.order.state.completedEMPTYorder:read{"entity":"order"}
state_leave.order.state.in_progressEMPTYorder:read{"entity":"order"}
state_leave.order.state.openEMPTYorder:read{"entity":"order"}
state_leave.order_delivery.state.cancelledEMPTYorder:read{"entity":"order"}
state_leave.order_delivery.state.openEMPTYorder:read{"entity":"order"}
state_leave.order_delivery.state.returnedEMPTYorder:read{"entity":"order"}
state_leave.order_delivery.state.returned_partiallyEMPTYorder:read{"entity":"order"}
state_leave.order_delivery.state.shippedEMPTYorder:read{"entity":"order"}
state_leave.order_delivery.state.shipped_partiallyEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.authorizedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.cancelledEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.chargebackEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.failedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.in_progressEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.openEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.paidEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.paid_partiallyEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.refundedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.refunded_partiallyEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.remindedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction.state.unconfirmedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture.state.completedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture.state.failedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture.state.pendingEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture_refund.state.cancelledEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture_refund.state.completedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture_refund.state.failedEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture_refund.state.in_progressEMPTYorder:read{"entity":"order"}
state_leave.order_transaction_capture_refund.state.openEMPTYorder:read{"entity":"order"}
user.recovery.requestEMPTYuser_recovery:read{"entity":"user_recovery","resetUrl":"string"}
product.writtenTriggers when a product is writtenproduct:read{"entity":"product","operation":"update insert","primaryKey":"array string","payload":"array"}
product.deletedTriggers when a product is deletedproduct:read{"entity":"product","operation":"deleted","primaryKey":"array string","payload":"array"}
product_price.writtenTriggers when a product_price is writtenproduct_price:read{"entity":"product_price","operation":"update insert","primaryKey":"array string","payload":"array"}
product_price.deletedTriggers when a product_price is deletedproduct_price:read{"entity":"product_price","operation":"deleted","primaryKey":"array string","payload":"array"}
category.writtenTriggers when a category is writtencategory:read{"entity":"category","operation":"update insert","primaryKey":"array string","payload":"array"}
category.deletedTriggers when a category is deletedcategory:read{"entity":"category","operation":"deleted","primaryKey":"array string","payload":"array"}
sales_channel.writtenTriggers when a sales_channel is writtensales_channel:read{"entity":"sales_channel","operation":"update insert","primaryKey":"array string","payload":"array"}
sales_channel.deletedTriggers when a sales_channel is deletedsales_channel:read{"entity":"sales_channel","operation":"deleted","primaryKey":"array string","payload":"array"}
sales_channel_domain.writtenTriggers when a sales_channel_domain is writtensales_channel_domain:read{"entity":"sales_channel_domain","operation":"update insert","primaryKey":"array string","payload":"array"}
sales_channel_domain.deletedTriggers when a sales_channel_domain is deletedsales_channel_domain:read{"entity":"sales_channel_domain","operation":"deleted","primaryKey":"array string","payload":"array"}
customer.writtenTriggers when a customer is writtencustomer:read{"entity":"customer","operation":"update insert","primaryKey":"array string","payload":"array"}
customer.deletedTriggers when a customer is deletedcustomer:read{"entity":"customer","operation":"deleted","primaryKey":"array string","payload":"array"}
customer_address.writtenTriggers when a customer_address is writtencustomer_address:read{"entity":"customer_address","operation":"update insert","primaryKey":"array string","payload":"array"}
customer_address.deletedTriggers when a customer_address is deletedcustomer_address:read{"entity":"customer_address","operation":"deleted","primaryKey":"array string","payload":"array"}
order.writtenTriggers when a order is writtenorder:read{"entity":"order","operation":"update insert","primaryKey":"array string","payload":"array"}
order.deletedTriggers when a order is deletedorder:read{"entity":"order","operation":"deleted","primaryKey":"array string","payload":"array"}
order_address.writtenTriggers when a order_address is writtenorder_address:read{"entity":"order_address","operation":"update insert","primaryKey":"array string","payload":"array"}
order_address.deletedTriggers when a order_address is deletedorder_address:read{"entity":"order_address","operation":"deleted","primaryKey":"array string","payload":"array"}
document.writtenTriggers when a document is writtendocument:read{"entity":"document","operation":"update insert","primaryKey":"array string","payload":"array"}
document.deletedTriggers when a document is deleteddocument:read{"entity":"document","operation":"deleted","primaryKey":"array string","payload":"array"}
media.writtenTriggers when a media is writtenmedia:read{"entity":"media","operation":"update insert","primaryKey":"array string","payload":"array"}
media.deletedTriggers when a media is deletedmedia:read{"entity":"media","operation":"deleted","primaryKey":"array string","payload":"array"}
app.activated-
app.deactivated-
app.deleted-
app.installed-
app.updated-
shopware.updated-