Introduction

Integration & Embedding

Rebound Events

Business Parameters

Email Templates

Outbound Events

Item Types

Amazon Selling Partner

Webhooks

General

Communication

Technical Concepts

Self Service Portal

Integrations

Order Management

Sales Channel

Help Desk

Event

Logistics Provider

Fulfillment

Product Information Management

Storage

Entities & Data

Products

<h2>About</h2><p>When your system needs information about specific events that have occurred within a customer's service journey, it can subscribe to webhook topics as a mechanism for receiving near-real-time data about these events.</p><p>Webhooks in our post-purchase service management solution are useful for keeping your systems in sync with service data, or as a trigger to perform additional actions after specific events have occurred. They are also a performant alternative to continuously polling for changes to service data.</p><p>This guide provides a quick primer on when to use APIs versus webhooks, as well as key terminology and behaviors that are specific to our post-purchase service management webhooks.</p><h2>Minimalist Approach to Webhook Payloads</h2><p>Our webhook system is designed with efficiency in mind. The webhook payload sent to your defined endpoint is intentionally minimal, containing just enough information to notify you that a specific event transition has occurred. This approach:</p><ul><li>Reduces unnecessary data transfer</li><li>Minimizes processing requirements</li><li>Aligns with returns.cloud's philosophy of minimal data requirements</li></ul><p>For example, a webhook notification about a status change to "delivered" might be sufficient for your needs without requiring additional data. In cases where more details are needed, your system can use our GraphQL API to request precisely the information required—no more, no less.</p><p>This design mirrors our GraphQL implementation, where you can specify exactly which data fields you need, avoiding the overhead of receiving unwanted information.</p><h2>Retry Mechanism</h2><p>We understand that endpoint availability is not guaranteed 100% of the time. To ensure reliable message delivery, our webhook system includes a robust retry mechanism:</p><ul><li>If your endpoint is unavailable or fails to respond, we don't simply discard the webhook notification</li><li>Our system will automatically attempt to redeliver the payload up to 5 times</li><li>Each retry attempt follows a progressive delay pattern to avoid overwhelming your system</li><li>This approach ensures important event notifications are not lost due to temporary connectivity issues</li></ul><p>By combining minimal payloads with reliable delivery mechanisms, our webhook system provides an efficient and dependable way to keep your systems synchronized with post-purchase service events.</p><h2>API vs. Webhooks</h2><p>APIs require your system to make requests to our service at regular intervals to check for updates, which is known as polling. This approach is effective when you need to retrieve data on demand, but it can be inefficient for tracking real-time events.</p><p>Webhooks, on the other hand, allow our service to notify your system immediately when specific events occur. This "push" model ensures timely updates without the overhead of frequent polling, making webhooks ideal for event-driven workflows in your post-purchase service processes.</p><h3>Key Benefits</h3><ul><li><strong>Real-time notifications</strong>: Receive immediate updates when service events occur</li><li><strong>Reduced system load</strong>: Eliminate the need to constantly poll our API for changes</li><li><strong>Workflow automation</strong>: Trigger automated processes based on specific service events</li><li><strong>Data synchronization</strong>: Keep your local data in sync with our service management platform</li></ul><h2>Examples of when you might use webhooks</h2><h3><span style="color:rgb(0,0,0);">Keeping Your Warehouse Operations Updated</span></h3><p>Event: <code>return_order_parcel.status.changed</code></p><p>Keep your warehouse planning efficient and up-to-date by receiving notifications about return parcel status changes. These updates provide critical information about:</p><ul><li>When parcels will arrive</li><li>Which items are included in each parcel</li><li>Which warehouse is set as the destination</li></ul><p>The system tracks all returned shipments regardless of origin:</p><ul><li>Customer-initiated returns</li><li>Returns using pre-printed labels</li><li>Undelivered outbound shipments that bounced back</li><li>Items not collected by customers from pick-up locations</li></ul><h3><span style="color:rgb(0,0,0);">Updating Your Customer-Facing Interface</span></h3><p>Event: <code>sales_order_parcel.status.changed</code></p><p><span style="color:rgb(0,0,0);">Just as you can trigger processes for incoming returns, you can also leverage webhooks for outbound shipment events. Our customers most commonly use the "delivered" status update to refresh their shop frontend, providing customers with real-time delivery information without manual intervention.</span></p><h3><span style="color:rgb(0,0,0);">Managing Shipping Exceptions</span></h3><p>Event: <code>return_order_parcel.status.changed</code> &amp; <code>sales_order_parcel.status.changed</code></p><p>Parcels may encounter operational exceptions during transport—both outbound to your customers and as returns coming back to your warehouse. Webhooks allow you to respond quickly to issues such as:</p><ul><li>Incorrect delivery addresses</li><li>Customs clearance complications</li><li>Items not collected from pick-up locations</li></ul><p>By receiving immediate notifications about these exceptions, you can take proactive steps to resolve issues before they impact customer satisfaction.</p><h2>Events</h2><ul><li>Return Order Status Change&nbsp;<br><code>return_order.status.changed</code></li><li>Return Order Parcel Status Change&nbsp;<br><code>return_order_parcel.status.changed</code></li><li>Sales Order Status Change&nbsp;<br><code>sales_order.status.changed</code></li><li>Sales Order Parcel Status Change&nbsp;<br><code>sales_order_parcel.status.changed</code></li><li>Payment Operation Status Change&nbsp;<br><code>payment_operation.status.changed</code></li></ul><h2>Example Payload</h2><p>Below is a sample webhook notification that illustrates a return order status change. In this example, the status has transitioned from "approved" (indicating the return was initially accepted) to "option_selected" (indicating the customer has now chosen their preferred return method). This minimal payload provides just enough information to alert your system about the status change, allowing you to decide whether additional details should be retrieved via our GraphQL API. For comprehensive information about all possible status values and their meanings in the workflow, please refer to our status documentation at: <a href="https://help.returns.cloud/en/article/entity-status-model">https://help.returns.cloud/en/article/entity-status-model</a></p><pre><code class="language-typescript">{
    	"event":"return_order.status.changed",
    	"oldStatus":"approved",
    	"newStatus":"option_selected",
    	"returnOrder": 
    	{
    		"number":"100004",
    		"uuid":"90aabf83-d23c-4792-b483-2546b8041379-071569a0-99d9-43d2-a466-9f82408d1ae0",
    		"externalId":null
    	}
    }</code></pre><p>
</p>

Was this article helpful?

You recently requested to reset your password for your account. Use the button below to reset it. This password reset is only valid for the next 24 hours.

If you’re having trouble with the button above, copy and paste the URL below into your web browser.

Please check your email for instructions to reset your password.

Check your email

Enter your email address and we will send you instructions to reset your password.

returns.cloud Help Center

Self Service Portal

Technical Concepts

Featured Articles

Webhooks