Overview

The order webhook enables seamless real-time integration between our platform and external systems. Once configured by the third-party system in the developer dashboard, the webhook will automatically trigger whenever a new order is received.

How It Works

• External systems can register a webhook URL in the developer dashboard.
• When an order is placed on our platform, a real-time event triggers the webhook.
• The webhook sends a POST request to the configured external system, carrying order details in JSON format.
• Order objects can include line items, fulfillments, taxes, and discounts based on the transaction details.

Expected Response & Retries

• The external API endpoint must return a 2xx HTTP status code to acknowledge a successful request with the format mentioned in the response section below.
• If the response is outside the 2xx range, the platform will mark the delivery as failed and retry based on the configured retry logic.

Note:

• If an item has a discount, the total discounted amount for the item (considering its quantity) will be sent in the order.item.price.discountAmount attribute.
• The total of item-level discounts and order-level discounts will be reflected in the order.payment.discounts.amount attribute.

Refer our documentation on Push an Order JSON payload and a detailed breakdown of its attributes for more details.