Webhook Events Reference

Search…
Event
Description
Permissions needed
Payload
checkout.customer.before.login
Triggers as soon as a customer logs in
-
{"email":"string"}
checkout.customer.changed-payment-method
Triggers when a customer changes his payment method in the checkout process
customer:read
{"entity":"customer"}
checkout.customer.deleted
Triggers if a customer gets deleted
customer:read
{"entity":"customer"}
checkout.customer.double_opt_in_guest_order
Triggers as soon as double opt-in is accepted in a guest order
customer:read
{"entity":"customer","confirmUrl":"string"}
checkout.customer.double_opt_in_registration
Triggers when a customer commits to his registration via double opt in
customer:read
{"entity":"customer","confirmUrl":"string"}
checkout.customer.guest_register
EMPTY
customer:read
{"entity":"customer"}
checkout.customer.login
Triggers as soon as a customer logs in
customer:read
{"entity":"customer","contextToken":"string"}
checkout.customer.logout
Triggers when a customer logs out
customer:read
{"entity":"customer"}
checkout.customer.register
Triggers when a new customer was registered
customer:read
{"entity":"customer"}
checkout.order.payment_method.changed
EMPTY
order:read order_transaction:read
{"entity":"order_transaction"}
checkout.order.placed
Triggers when an order is placed
order:read
{"entity":"order"}
contact_form.send
Triggers when a contact form is send
-
{"contactFormData":"object"}
customer.group.registration.accepted
EMPTY
customer:read customer_group:read
{"entity":"customer_group"}
customer.group.registration.declined
EMPTY
customer:read customer_group:read
{"entity":"customer_group"}
customer.recovery.request
Triggers when a customer recovers his password
customer_recovery:read customer:read
{"entity":"customer","resetUrl":"string","shopName":"string"}
mail.after.create.message
EMPTY
-
{"data":"array","message":"object"}
mail.before.send
Triggers before a mail is send
-
{"data":"array","templateData":"array"}
mail.sent
Triggers when a mail is send from Shopware
-
{"subject":"string","contents":"string","recipients":"array"}
newsletter.confirm
EMPTY
newsletter_recipient:read
{"entity":"newsletter_recipient"}
newsletter.register
EMPTY
newsletter_recipient:read
{"entity":"newsletter_recipient","url":"string"}
Manifest Reference
Payment Reference
Last modified 3mo ago
Copy link
Edit on GitHub