Skip to main content

Getting started with webhooks on Return Prime

Wonder Women avatar
Written by Wonder Women
Updated over a week ago

Why Use Webhooks?

Webhooks let you stay in sync with your return and refund operations—in real time. Whether you're building custom workflows or syncing Return Prime with your internal tools, webhooks help you automate, react, and track return lifecycle events effortlessly.

Common Use Cases

Here’s how leading merchants and developers use webhooks:

  • 📬 Automated Notifications: Trigger emails, SMS, or WhatsApp messages when a return is approved, refunded, or rejected.

  • 📦 Logistics Coordination: Alert warehouse or courier teams on return request creation or pickup confirmation.

  • 📊 Data Sync: Seamlessly push return/refund data to CRMs, ERPs, or analytics dashboards.

  • 🔄 Custom Workflows: Automatically initiate tasks in third-party tools like Slack, Trello, or custom backend systems.
    ​

How to Set Up Webhooks in Return Prime

Follow these simple steps to start receiving real-time updates via webhooks:


Step 1: Access Developer Settings

  • Go to your Return Prime dashboard

  • Navigate to: Settings → Integrations → Develop Apps

Step 2: Create a New App

  • Click on “Create New App”

  • Give your app a name (e.g., “Return Events Listener”)

  • Click Save

Step 3: Add Your Webhook URL

  • After the app is created, click into the app and go to the Webhooks tab

  • Under “Where do you want to receive the webhooks?”, enter your destination URL
    ​(e.g., https://yourdomain.com/webhook-endpoint)

Step 4: Subscribe to Events

Check the events you want to listen to. Available events include:

  • Request created

  • Request approved

  • Request updated

  • Request received

  • Request inspected

  • Request refunded

  • Request rejected

  • Request archived

  • Request refund failed

Select only the events you need to avoid unnecessary payloads and Click Save to finish setup.
​

What Happens Next?

Once enabled, Return Prime will automatically send a POST request to your provided URL every time a subscribed event is triggered. Each webhook includes structured JSON payloads with all relevant request data.

Make sure your system is ready to:

  • Handle POST requests

  • Log or process data

  • Respond with a 200 OK status to confirm delivery
    ​

Best Practices

  • Use secure (HTTPS) URLs for better security

  • Retry logic is recommended on your server in case of missed events

  • Keep a log of incoming events for auditing or debugging

​If you have any further questions or need additional assistance, please contact our support team at help@returnprime.com.

Did this answer your question?