Webhooks for Order Status Updates - Nov 2024

How Wakilni Webhooks Work

When your app or website needs information about specific events related to Wakilni order's status, it can subscribe to Wakilni webhook topics as a mechanism for receiving near-real-time updates about these events.

Wakilni webhooks are useful for keeping your app or website in sync with Wakilni order status updates or as triggers to perform additional actions after an event has occurred.

Webhooks for events

Webhooks for Order Creation Event

The list of Webhook events:

• 'Order Created'

• 'Order Confirmed'

• 'Order Declined'

• 'Order Assigned'

• 'Order Processed'

• 'Order Canceled'

• 'Order Postponed'

• 'Order Completed'

• 'Order Completed Rejected'

• 'Order Closed Failed'

• 'Order Pending Cancelation'

• 'Order Failed'

• 'Order Ready for Self-Pickup'

The following data are sent in the header of the event:

• x-webhook-signature: a base64 encoded HMAC-SHA256 hash of the payload

• x-attempt-number: nb of attempts

• x-webhook-source: https://api.wakilni.com

• x-webhook-topic: e.g Order Canceled

• x-webhook-id: webhook_id

• x-webhook-delivery-id: delivery_id

Events Payload Samples:

Order Created:

{ "event_id": "e2986cd1-1e85-4ef1-a85a-89488dd27b92", "event": "Order Created", "timestamp": "2024-11-14 14:39:13", "data": { "order_id": ###, "waybill": "###", "created_at": "2024-11-14 14:39:10" }

Order Assigned:

{ "event_id": "e2986cd1-1e85-4ef1-a85a-89488dd27b92", "event": "Order Assigned", "timestamp": "2024-11-14 14:39:13", "data": { "order_id": ###, "waybill": "###",

"driver_name": ###, "driver_phone": "+961########", "updated_at": "2024-11-14 14:39:10" }

Order Ready for Self-Pickup:

{ "event_id": "e2986cd1-1e85-4ef1-a85a-89488dd27b92", "event": "Order Ready for Self-Pickup", "timestamp": "2024-11-14 14:39:13", "data": { "order_id": ###, "waybill": "###", "location": [

"office_name": "Wakilni Dekwaneh",

"phone_number": "+961########", ] }

For the rest of the events the payload sample will be as follow:

{ "event_id": "e2986cd1-1e85-4ef1-a85a-89488dd27b92", "event": "Order Confirmed", "timestamp": "2024-11-14 14:39:13", "data": { "order_id": ###, "waybill": "###", "new_status_code": 7, "new_status": "Confirmed", "previous_status_code": 1, "previous_status": "Pending", "updated_at": "2024-11-14 14:39:10" }

Subscribe to Wakilni Webhook

1. Login as client to Wakilni portal.

2. Go to "Settings".

3. Click "Webhooks" tab.

4. Click "Create Webhook" button.

5. Select your app token where the integration created with your shopify or WooCommerce account and Wakilni portal.

6. You are allowed to track many order's events through this webhook integration.

7. Click to select on of these events.

8. Check to enable this webhook.

9. Add the "Delivery URL" ,could be your app or web URL or any custom URL, where you want to receive the webhook updated events.

10. Click "CREATE".

11. You are able to edit or delete your webhooks created.

Tip: For your inquiries, please don�t hesitate to contact us on [e-mail]