Webhooks

Brink Commerce API supports webhooks on order or product status changes. If you need multiple hooks, create them using different hook names.

Hint

The easiest way to set up and manage webhooks is through Brink Merchant Portal; just navigate to Configurations -> Webhooks

Brink Commerce API will POST a sample message to the endpoint provided to verify its validity. If there was a problem for Brink Commerce API to POST to the configured URL you will receive a (400 Bad Request)

Verification message:

{
  "message": "Hello from Brink Commerce"
}

Order callback

Brink Commerce will send a callback for when there is a state change on order.

State values are (success|refunded|canceled|shipped|waiting)

Example of a callback:

{
  "service": "order",
  "state": "success",
  "orderId": "f3a1b916-63b5-469f-8654-2762d5ca8589"
}

Product callback

Brink Commerce will send a callback for when there is a state change on product.

State values are (created|updated)

Example of a callback:

{
  "service": "product",
  "state": "created",
  "productId": "e9fd11fb-ce94-4eee-a253-3c180a94f857"
}