Brand

Below are the webhook store events paired with their respective data schema related to the Brand webhook events:

Brand Webhook Events Model

The following includes 3 brands webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab

Data Schema

Example

Brands Webhook Events Model

event

enum<string>

optional

Event Name

Allowed values:

brand.createdbrand.updatedbrand.deleted

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

created_at

string

optional

Timestamp of the created event

data

object (Brand)

optional

Detailed structure of the brand model object showing its fields and data types.

number

required

A unique identifier assigned to a specific brand.

name

string

required

The label given to a particular company, to identify its products in the market. 🌐 Support multi-language

description

string

required

A brief summary of a company, highlighting key attributes, values, and offerings to convey its identity and purpose. 🌐 Support multi-language

banner

string

required

A text or URL linking to a banner file, used as a visual identifier for a brand on a webpage or platform.

logo

string

required

A text-based representation or URL link that directs to the logo file.

ar_char

string

required

Brand represented in Arabic characters.

en_char

string

required

Brand represented in English characters.

metadata

object

required

Brand Webhook Events Model#

Brand Webhook Events Model