Register Order Webhook

This endpoint stores client webhook (url) for to be called when an Order is created or altered. A successful response includes the order number and the status of the order.

Note that the registered url should be a POST route. Json body will be sent to this route and will contain orderNumber and orderStatus as request body.

Register.

POST /webhooks/store

Headers

Name
Type
Description

secret-key*

user secret key

Authorization*

Token

{
    "status": "Success",
    "description": "Request successful",
    "data": {
        "webhook": "https://example.com",
        "webhooks": [
            {
                "url": "https://example.com",
                "type": "App\\Models\\Order",
                "is_active": 1
            }
        ]
    }
}

Last updated