Webhooks

Receive order completion notifications automatically instead of relying entirely on polling.

 

Webhooks allow the platform to notify your application when an order has completed fulfillment. They are especially helpful for larger orders that may process asynchronously.

Webhook setting

Provide a FulfillmentComplete webhook URL as part of your order request.

JSON 
{
  "WebhookSettings": {
    "FulfillmentComplete": "https://example.com/webhooks/fulfillment-complete"
  }
}

How it works

  1. Your system submits an order
  2. The API returns an order response
  3. If the order completes asynchronously, the platform posts to your webhook URL
  4. Your application processes the notification and updates internal state

Fallback option

If you do not use webhooks, you can poll the order endpoint to check status.

GET /v1/Orders/{id}
Tip: Treat webhook events as signals and design your webhook handler to safely process retries or duplicate deliveries.

Recommended practices

  • Use HTTPS endpoints
  • Return a 2xx response quickly
  • Make handlers idempotent
  • Log webhook activity for debugging

What’s next