Merchants
Webhook Events

Webhook Events by State

This page describes which webhook eventType is dispatched based on the current state of a merchant order or return.

If a state does not match any mapping, no webhook is dispatched.


Order states → events

order.created

Dispatched when the state is one of the following:

  • New
  • Registered
  • In processing
  • Ready for Shipment
  • Picked by Courier

order.delivered

Dispatched when the state is one of the following:

  • Delivered to customer
  • Delivered to Clever Point

order.canceled

Dispatched when the state is one of the following:

  • Canceled
  • Reallocation or Rejection

order.deliveryFailed

Dispatched when the state is:

  • Delivery Failed

Return states → events

return.created

Dispatched when the state is:

  • Return Voucher created

return.deliveringToStore

Dispatched when the state is one of the following:

  • Return Delivering to Store
  • Return Delivered to Store

return.canceled

Dispatched when the state is:

  • Return Canceled

return.waitingForSupport

Dispatched when the state is:

  • Waiting for Support Approval

return.completed

Dispatched when the state is:

  • Return completed

States without webhook dispatch

States that are not included in the mappings above do not produce any webhook event.


Summary table

StateWebhook eventType
Neworder.created
Registeredorder.created
In processingorder.created
Ready for Shipmentorder.created
Picked by Courierorder.created
Delivered to customerorder.delivered
Delivered to Clever Pointorder.delivered
Canceledorder.canceled
Reallocation or Rejectionorder.canceled
Delivery Failedorder.deliveryFailed
Return Voucher createdreturn.created
Return Delivering to Storereturn.deliveringToStore
Return Delivered to Storereturn.deliveringToStore
Return Canceledreturn.canceled
Waiting for Support Approvalreturn.waitingForSupport
Return completedreturn.completed