Platform Webhook

Request Metadata

Field	Description
URL	https://api.breeze.in/webhook/platform
Method	POST

Request Headers

Field	Description
Content-Type	application/json
X-Api-Key	get Api-Key from Breeze

Request Payload

Request Body

Name	Type	Description	Example	Mandatory
shopUrl	String	Shop URL of the shop	https://pre.megamartfashions.com	Yes
event	String	Event information	OrderDelivered	Yes
eventData	EventData	Details of the event	-	Yes

EventData

Name	Type	Description	Example	Mandatory
orderId	String	ID of the order	-	Yes
items	Array<Item>	Items to be considered	-	Yes

Item

Name	Type	Description	Example	Mandatory
itemId	String	ID of the item	-	Conditional (*)
productId	String	ID of the product	-	Conditional (*)
variantId	String	ID of the variant	-	Conditional (*)

Note: At least one of item_id, product_id, or variant_id must be provided.

Response Body

If the webhook is processed successfully, we will return a 200 status code with the following response body:

Name	Type	Description	Example	Mandatory
status	String	Status of the webhook	SUCCESS	Yes
message	String	Message for the webhook	Webhook processed successfully	Yes
data	Data	webhook related data	-	Yes

Data

Name	Type	Description	Example	Mandatory
orderId	String	Order ID	q8A0DCeE-iz9NKO2VAYnh	Yes
processedAt	String	Timestamp when order was processed	"2025-03-13T12:34:56Z"	Yes

---

Example Request Body

{
  "shopUrl": "https://pre.megamartfashions.com",
  "event": "OrderDelivered",
  "eventData": {
    "orderId": "12345",
    "items": [
      {
        "itemId": "item1",
        "productId": "product1",
        "variantId": "variant1"
      },
      {
        "itemId": "item2",
        "productId": "product2",
        "variantId": "variant2"
      }
    ]
  }
}

Example Response Body

{
  "status": "success",
  "message": "Webhook processed successfully",
  "data": {
    "orderId": "123456",
    "processedAt": "2025-03-13T12:34:56Z"
  }
}