Configuration

It is possible to programmatically modify the webhook URLs configured for your account.

View Configuration

To get the current webhook configuration make a GET request to /api/v1/fulfillment/webhooks

The response will be in the following format

{
  "refund_url": "https://example.com/order/refund",
  "credit_url": "https://example.com/order/credit",
  "redelivery_url": "https://example.com/order/redelivery",
  "status_url": "https://example.com/order/status",
  "rider_status_url": "https://example.com/order/rider_status"
}

Update Configuration

To update the webhooks make a POST request to /api/v1/fulfillment/webhooks

If you do not wish to receive order status updates (and perhaps poll the order endpoint instead), you can omit the status_url.

The request body should be in the same format as the GET response.

{
  "refund_url": "https://new-webhook-example.com/order/refund",
  "credit_url": "https://new-webhook-example.com/order/credit",
  "redelivery_url": "https://new-webhook-example.com/order/redelivery",
  "status_url": "https://new-webhook-example.com/order/status",
  "rider_status_url": "https://new-webhook-example.com/order/rider_status"
}