Skip to main content

How to Receive Return Request Updates by Webhook Push

Receive Return Request Updates by Webhook Push in AfterShip Returns: follow setup steps, configure key options, verify behavior, and troubleshoot workflow.

Written by Harneet Kaur

Plans: Premium, Enterprise | Platforms: All platforms

Overview

Webhooks are a gateway to receive real-time updates at a particular destination you define. AfterShip Returns allows you to easily create and manage webhooks and get real-time return request updates when events of interest occur.

Set up webhook push

  1. Go to Settings > Webhooks in your AfterShip Returns admin
    ​

  2. Click Create new webhook.
    ​

  3. Add the Endpoint URL and Description of what the webhook will be used for in the General settings
    ​

Note: Please ensure that the endpoint URL you set to receive notifications can be accessed.

Additionally, verify that your email/domain is properly configured to ensure notification delivery.

4. Under the Events section, select the product from the dropdown for which you want to get notifications.


5. Select the Product from the dropdown.

  • AfterShip Returns

  • AfterShip Protection

  • AfterShip Warranty

Users can now select which version of Returns Webhooks to use and can then check the events which can trigger a webhook notification.

AfterShip Returns

AfterShip Protection

AfterShip Warranty

Refer to our API documentation for more details. The Returns API is restricted to Premium and Enterprise plan users, and notification toggles are managed via the admin panel.

Notification settings

To ensure customers receive return labels and approval emails.

  1. Verify your sending email/domain in the AfterShip Returns admin.

  2. Enable customer-facing notifications for return approval and label generation. These settings ensure that customers are notified promptly when a return is approved and receive the necessary return label.

For troubleshooting, ensure your endpoint URL is accessible, verify email/domain configuration, and check your subscription plan for API access eligibility.

Need help?

For any further questions or help, please contact our chat support team or reach out to us at [email protected].

Did this answer your question?