Skip to content

Webhooks

Webhooks

To receive real-time updates on the status of orders placed through your app, you can provide a webhook URL in the Armada delivery Merchant UI. Our API will send a POST request to this URL any time the status of an order changes.

The list of the statuses:

  • pending: the order has been received and is waiting to be dispatched to a driver
  • dispatched: the order has been dispatched to a driver who is on his way to the merchant
  • en route: the order has been picked up from the merchant and is being delivered to the customer
  • complete: the order has been successfully delivered
  • canceled: the order has been canceled from the merchant
  • failed: the order has failed to find a driver

Response

  • code: The Id Of the delivery within Armada,
  • deliveryFee: The cost of the Delivery,
  • amount: The order Amount of the order set by the merchant,
  • customerAddress: The customer Address generated by Armada based on the data sent by the Platform,
  • customerLocation: The customer Location { latitude: '', longitude: '' } based on the data sent by the platform,
  • customerName: Customer Name,
  • customerPhone: Customer Phone,
  • orderStatus: The Order Status,
  • estimatedDistance: Estimated Distance from the pick up to the customer location in Meters,
  • estimatedDuration: Estimated Duration from the pick up to the customer location in Seconds,
  • driver: An object containing the driver information.
    • name: String.
    • phoneNumber: String.
    • latitude: Number.
    • longitude: Number.
  • trackingLink: A link to a public Page showing a live of the delivery progress,
  • qrCodeLink: A link to the QR code, to show to the driver, to scan the delivery in case the scan is not performed within the merchant dasboard,
  • orderCreatedAt: Date of the Delivery Creation,
  • currency: The currency used for this delivery.

In headers:

  • Authorization: The value of your order-webhook-key you provide when you create the order.