Webhook Event Reference
| Event | Description | Permissions needed | Payload |
|---|---|---|---|
checkout.customer.before.login | Triggers as soon as a customer logs in | - | |
checkout.customer.deleted | Triggers if a customer gets deleted | customer:read | |
checkout.customer.double_opt_in_guest_order | Triggers as soon as double opt-in is accepted in a guest order | customer:read | |
checkout.customer.double_opt_in_registration | Triggers when a customer commits to his registration via double opt in | customer:read | |
checkout.customer.guest_register | EMPTY | customer:read | |
checkout.customer.login | Triggers as soon as a customer logs in | customer:read | |
checkout.customer.logout | Triggers when a customer logs out | customer:read | |
checkout.customer.register | Triggers when a new customer was registered | customer:read | |
checkout.order.payment_method.changed | EMPTY | order:read order_transaction:read | |
checkout.order.placed | Triggers when an order is placed | order:read | |
contact_form.send | Triggers when a contact form is send | - | |
customer.group.registration.accepted | EMPTY | customer:read customer_group:read | |
customer.group.registration.declined | EMPTY | customer:read customer_group:read | |
customer.password.changed | EMPTY | customer:read | |
customer.recovery.request | Triggers when a customer recovers his password | customer_recovery:read customer:read | |
mail.after.create.message | EMPTY | - | |
mail.before.send | Triggers before a mail is send | - | |
mail.sent | Triggers when a mail is send from Shopware | - | |
newsletter.confirm | EMPTY | newsletter_recipient:read | |
newsletter.register | EMPTY | newsletter_recipient:read | |
newsletter.unsubscribe | EMPTY | newsletter_recipient:read | |
product_export.log | EMPTY | - | |
review_form.send | Triggers when a product review form is send | product:read | |
revocation_request.sent | EMPTY | - | |
state_enter.order.state.cancelled | EMPTY | order:read | |
state_enter.order.state.completed | EMPTY | order:read | |
state_enter.order.state.in_progress | EMPTY | order:read | |
state_enter.order.state.open | EMPTY | order:read | |
state_enter.order_delivery.state.cancelled | EMPTY | order:read | |
state_enter.order_delivery.state.open | EMPTY | order:read | |
state_enter.order_delivery.state.returned | EMPTY | order:read | |
state_enter.order_delivery.state.returned_partially | EMPTY | order:read | |
state_enter.order_delivery.state.shipped | EMPTY | order:read | |
state_enter.order_delivery.state.shipped_partially | EMPTY | order:read | |
state_enter.order_transaction.state.authorized | EMPTY | order:read | |
state_enter.order_transaction.state.cancelled | EMPTY | order:read | |
state_enter.order_transaction.state.chargeback | EMPTY | order:read | |
state_enter.order_transaction.state.failed | EMPTY | order:read | |
state_enter.order_transaction.state.in_progress | EMPTY | order:read | |
state_enter.order_transaction.state.open | EMPTY | order:read | |
state_enter.order_transaction.state.paid | EMPTY | order:read | |
state_enter.order_transaction.state.paid_partially | EMPTY | order:read | |
state_enter.order_transaction.state.refunded | EMPTY | order:read | |
state_enter.order_transaction.state.refunded_partially | EMPTY | order:read | |
state_enter.order_transaction.state.reminded | EMPTY | order:read | |
state_enter.order_transaction.state.unconfirmed | EMPTY | order:read | |
state_enter.order_transaction_capture.state.completed | EMPTY | order:read | |
state_enter.order_transaction_capture.state.failed | EMPTY | order:read | |
state_enter.order_transaction_capture.state.pending | EMPTY | order:read | |
state_enter.order_transaction_capture_refund.state.cancelled | EMPTY | order:read | |
state_enter.order_transaction_capture_refund.state.completed | EMPTY | order:read | |
state_enter.order_transaction_capture_refund.state.failed | EMPTY | order:read | |
state_enter.order_transaction_capture_refund.state.in_progress | EMPTY | order:read | |
state_enter.order_transaction_capture_refund.state.open | EMPTY | order:read | |
state_leave.order.state.cancelled | EMPTY | order:read | |
state_leave.order.state.completed | EMPTY | order:read | |
state_leave.order.state.in_progress | EMPTY | order:read | |
state_leave.order.state.open | EMPTY | order:read | |
state_leave.order_delivery.state.cancelled | EMPTY | order:read | |
state_leave.order_delivery.state.open | EMPTY | order:read | |
state_leave.order_delivery.state.returned | EMPTY | order:read | |
state_leave.order_delivery.state.returned_partially | EMPTY | order:read | |
state_leave.order_delivery.state.shipped | EMPTY | order:read | |
state_leave.order_delivery.state.shipped_partially | EMPTY | order:read | |
state_leave.order_transaction.state.authorized | EMPTY | order:read | |
state_leave.order_transaction.state.cancelled | EMPTY | order:read | |
state_leave.order_transaction.state.chargeback | EMPTY | order:read | |
state_leave.order_transaction.state.failed | EMPTY | order:read | |
state_leave.order_transaction.state.in_progress | EMPTY | order:read | |
state_leave.order_transaction.state.open | EMPTY | order:read | |
state_leave.order_transaction.state.paid | EMPTY | order:read | |
state_leave.order_transaction.state.paid_partially | EMPTY | order:read | |
state_leave.order_transaction.state.refunded | EMPTY | order:read | |
state_leave.order_transaction.state.refunded_partially | EMPTY | order:read | |
state_leave.order_transaction.state.reminded | EMPTY | order:read | |
state_leave.order_transaction.state.unconfirmed | EMPTY | order:read | |
state_leave.order_transaction_capture.state.completed | EMPTY | order:read | |
state_leave.order_transaction_capture.state.failed | EMPTY | order:read | |
state_leave.order_transaction_capture.state.pending | EMPTY | order:read | |
state_leave.order_transaction_capture_refund.state.cancelled | EMPTY | order:read | |
state_leave.order_transaction_capture_refund.state.completed | EMPTY | order:read | |
state_leave.order_transaction_capture_refund.state.failed | EMPTY | order:read | |
state_leave.order_transaction_capture_refund.state.in_progress | EMPTY | order:read | |
state_leave.order_transaction_capture_refund.state.open | EMPTY | order:read | |
user.recovery.request | EMPTY | user_recovery:read | |
sales_channel.written | Triggers when a sales_channel is written | sales_channel:read | |
sales_channel.deleted | Triggers when a sales_channel is deleted | sales_channel:read | |
sales_channel_domain.written | Triggers when a sales_channel_domain is written | sales_channel_domain:read | |
sales_channel_domain.deleted | Triggers when a sales_channel_domain is deleted | sales_channel_domain:read | |
category.written | Triggers when a category is written | category:read | |
category.deleted | Triggers when a category is deleted | category:read | |
media.written | Triggers when a media is written | media:read | |
media.deleted | Triggers when a media is deleted | media:read | |
product.written | Triggers when a product is written | product:read | |
product.deleted | Triggers when a product is deleted | product:read | |
product_price.written | Triggers when a product_price is written | product_price:read | |
product_price.deleted | Triggers when a product_price is deleted | product_price:read | |
customer.written | Triggers when a customer is written | customer:read | |
customer.deleted | Triggers when a customer is deleted | customer:read | |
customer_address.written | Triggers when a customer_address is written | customer_address:read | |
customer_address.deleted | Triggers when a customer_address is deleted | customer_address:read | |
document.written | Triggers when a document is written | document:read | |
document.deleted | Triggers when a document is deleted | document:read | |
order.written | Triggers when a order is written | order:read | |
order.deleted | Triggers when a order is deleted | order:read | |
order_address.written | Triggers when a order_address is written | order_address:read | |
order_address.deleted | Triggers when a order_address is deleted | order_address:read | |
media.uploaded | Fires when a media file is uploaded | media:read | |
app.activated | Fires when an app is activated | - | |
app.deactivated | Fires when an app is deactivated | - | |
app.deleted | Fires when an app is deleted | - | |
app.installed | Fires when an app is installed | - | |
app.updated | Fires when an app is updated | - | |
app.permissions.updated | Fires when an apps permissions were updated with a list of the currently accepted permissions, eg after new were accepted or revoked | - | |
shopware.updated | Fires after an shopware update has been finished | - | |
app.config.changed | Fires when a system config value is changed | system_config:read | |
app.system_heartbeat | Fires as a recurrent task. Indicates to the app that the system is up and running. | - |
