Brikl Logo

BETA

/
Gear Icon
Webhooks

Webhooks Overview

Integration between apps plays a vital role in modern e-commerce businesses. For this purpose, the Brikl platform provides real-time notifications through webhooks.

Webhooks allow external apps to stay in sync with your store by providing data about specific events in your shop.

For example, a webhook can notify an app when a customer places a new order in your shop.

This page will introduce you to webhooks and present the currently available webhooks in the Brikl platform.

If you have a Brikl store and need to use webhooks to build integrations with external apps, please email us at support@brikl.com. Our integration team is ready to help you.


What are webhooks?

Webhooks are automated messages sent between apps. They notify an app about an event in another app and send detailed information about this event.

Brikl can send a webhook to an app when an event occurs in your shop. Brikl can also receive a webhook from your app when an event occurs on it.

A webhook is a single event message sent as a POST request to an endpoint. It contains a JSON payload in the body that holds relevant data about the event.

Here's a summary of how it works:

  1. The external app subscribes to the ORDER_CREATED event and listens for order creations in your store.
  2. The app specifies an HTTPS endpoint to receive notifications about new orders in your store.
  3. A customer places an order in your shop.
  4. Brikl sends a webhook to the specified endpoint with data about the order.
  5. Your app receives the data and updates the system with information about the order.

The opposite is also possible: an external app can send notifications to your Brikl store when a particular event happens.

For example, if you modify an order in your accounting system, you can notify your Brikl shop to update the order, allowing both apps to stay in sync.


Use cases

Common webhook use cases include the following:

  • Notify accounting systems about new orders or updates in existing orders
  • Update order payment status in accounting systems
  • Update shipping status in shipping management systems
  • Notify external systems and stakeholders about the closing of a microstore

Brikl webhooks

The Brikl platform offers a range of webhooks to allow integration between apps.

Explore the available webhooks below to determine which one fulfills your integration needs.

Once you identify it, please email us at support@brikl.com, and our integration team will provide all the technical support your business need.


Incoming webhooks

Incoming webhooks allow apps to notify a Brikl store about an event that has taken place in an external app.

Creating an Incoming Webhook gives you a unique URL to which your external app can send a JSON payload with information about the event.

Brikl uses Incoming webhooks to update your store with data coming from an external source.


Order created

Store owners that use an accounting system to manage orders might want to update their Brikl shop every time a new order is added to their system.

Brikl can receive a data payload from external systems and use it to add the newly created order in a Brikl shop so that both systems stay in sync.


Outgoing webhooks

Outgoing webhooks allow a Brikl store to notify an external app about an event that has taken place in a shop.

The Outgoing webhook will send data about the event as a JSON payload, and an external application can use it to update things like the payment or shipping status for an order.


Microstore closed

Store owners can close a microstore at any time. When this happens, Brikl can send a payload notifying an external system about this event.


Order created

Merchants might want to notify a system every time a customer places a new order in their Brikl shop. That can be the case if a merchant uses an accounting system to manage customer orders.

Brikl can send a payload with data about the recently created order when a customer places a new order in your shop.


Order updated

A merchant might want to update one order in an accounting system every time some data about it is modified in a Brikl shop. For that purpose, Brikl sends a payload with the modified data so that the accounting system and the Brikl shop can stay in sync.


Payment status

A typical integration use case between an online shop and an external system is to update a payment status every time a payment transitions its status.

For these cases, Brikl can send a payload with the new payment status.


Shipping status

As with payment status, keeping shipping status synced across different applications is crucial for many businesses.

Brikl can notify a shipping management system every time a shipping status changes.