wbhk returnStatusChange
Supported Return Webhooks
All return-related webhooks are closely tied to the status of the return. Each webhook is triggered by a specific status transition, marking important stages in the return process.
- Return created (
status:status_created) - Return in progress (
status:in_progress) - Return en route (
status:en_route) - Return returned (
status:returned)
Payload Structure (JSON Schema)
The payload of each return-related webhook matches the structure of a single return object as returned by the GET /v1/integrations/returns-list endpoint. While the GET /v1/integrations/returns-list endpoint responds with an array of return objects (returns-list field), each webhook delivers the full data of one return in the same format. This allows for easy reuse of the return model across both API responses and webhook events.