Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Address

This event will be generated where there is any action done on address

Events

application/address/create/v1

# this event is triggered when address is created

application/address/delete/v1

# this event is triggered when address is deleted

application/address/update/v1

# this event is triggered when address is updated

application/address/create/v1

this event is triggered when address is created

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/address/delete/v1

this event is triggered when address is deleted

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/address/update/v1

this event is triggered when address is updated

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Article

This event will be generated where there is any action done on article

Events

application/article/create/v1

# this event is triggered when article is created

application/article/delete/v1

# this event is triggered when article is deleted

application/article/update/v1

# this event is triggered when article is updated

application/article/create/v1

this event is triggered when article is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/article/delete/v1

this event is triggered when article is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/article/update/v1

this event is triggered when article is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Available pages

This event will be generated where there is any action done on available_pages

Events

application/available_pages/create/v1

# this event is triggered when available_pages is created

application/available_pages/delete/v1

# this event is triggered when available_pages is deleted

application/available_pages/update/v1

# this event is triggered when available_pages is updated

application/available_pages/create/v1

this event is triggered when available_pages is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/available_pages/delete/v1

this event is triggered when available_pages is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/available_pages/update/v1

this event is triggered when available_pages is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Cart price adjustment

This event will be generated where there is any action done on cart-price-adjustment

Events

application/cart-price-adjustment/create/v1

# this event is triggered when cart-price-adjustment is created

application/cart-price-adjustment/remove/v1

# this event is triggered when cart-price-adjustment is removed

application/cart-price-adjustment/update/v1

# this event is triggered when cart-price-adjustment is updated

application/cart-price-adjustment/create/v1

this event is triggered when cart-price-adjustment is created

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

This contains event data like name and type of event.

Properties

payload

object

The payload data of event.

Properties

Payload Schema JSON

Payload Example

application/cart-price-adjustment/remove/v1

this event is triggered when cart-price-adjustment is removed

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

This contains event data like name and type of event.

Properties

payload

object

The payload data of event.

Properties

Payload Schema JSON

Payload Example

application/cart-price-adjustment/update/v1

this event is triggered when cart-price-adjustment is updated

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

This contains event data like name and type of event.

Properties

payload

object

The payload data of event.

Properties

Payload Schema JSON

Payload Example

Cart

This event will be generated where there is any action done on cart

Events

application/cart/create/v1

# this event is triggered when cart is created

application/cart/update/v1

# this event is triggered when cart is updated

application/cart/create/v1

this event is triggered when cart is created

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Payload details.

Properties

Payload Schema JSON

Payload Example

application/cart/update/v1

this event is triggered when cart is updated

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Collection

This event will be generated where there is any action done on collection

Events

application/collection/create/v2

# this event is triggered when collection is created

application/collection/delete/v2

# this event is triggered when collection is deleted

application/collection/update/v2

# this event is triggered when collection is updated

application/collection/create/v2

this event is triggered when collection is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/collection/delete/v2

this event is triggered when collection is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/collection/update/v2

this event is triggered when collection is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Configuration

This event will be generated where there is any action done on configuration

Events

application/configuration/create/v1

# this event is triggered when configuration is created

application/configuration/update/v1

# this event is triggered when configuration is updated

application/configuration/create/v1

this event is triggered when configuration is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

The payload containing various configuration settings.

Properties

Payload Schema JSON

Payload Example

application/configuration/update/v1

this event is triggered when configuration is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

The payload containing various configuration settings.

Properties

Payload Schema JSON

Payload Example

Coupon

This event will be generated where there is any action done on coupon

Events

application/coupon/create/v1

# this event is triggered when coupon is created

application/coupon/redeem/v1

# this event is triggered when coupon is redeemed

application/coupon/update/v1

# this event is triggered when coupon is updated

application/coupon/create/v1

this event is triggered when coupon is created

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

This contains event data like name and type of event.

Properties

payload

object

The payload data of event.

Properties

Payload Schema JSON

Payload Example

application/coupon/redeem/v1

this event is triggered when coupon is redeemed

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

This contains event data like name and type of event.

Properties

payload

object

The payload data of event.

Properties

Payload Schema JSON

Payload Example

application/coupon/update/v1

this event is triggered when coupon is updated

Payload

application_id

array|string

Application/sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

This contains event data like name and type of event.

Properties

payload

object

The payload data of event.

Properties

Payload Schema JSON

Payload Example

Courier partner

This event will be generated where there is any action done on courier-partner

Events

application/courier-partner/assign/v1

# this event is triggered when courier-partner is assigned

application/courier-partner/cancel/v1

# this event is triggered when courier-partner is canceled

application/courier-partner/assign/v1

this event is triggered when courier-partner is assigned

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/courier-partner/cancel/v1

this event is triggered when courier-partner is canceled

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Discount

This event will be generated where there is any action done on discount

Events

application/discount/create/v1

# this event is triggered when discount is created

application/discount/end/v1

# this event is triggered when discount is ended

application/discount/start/v1

# this event is triggered when discount is started

application/discount/update/v1

# this event is triggered when discount is updated

application/discount/create/v1

this event is triggered when discount is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/discount/end/v1

this event is triggered when discount is ended

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/discount/start/v1

this event is triggered when discount is started

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/discount/update/v1

this event is triggered when discount is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Domain

This event will be generated where there is any action done on domain

Events

application/domain/create/v1

# this event is triggered when domain is created

application/domain/delete/v1

# this event is triggered when domain is deleted

application/domain/create/v1

this event is triggered when domain is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/domain/delete/v1

this event is triggered when domain is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Faq

This event will be generated where there is any action done on faq

Events

application/faq/create/v1

# this event is triggered when faq is created

application/faq/delete/v1

# this event is triggered when faq is deleted

application/faq/update/v1

# this event is triggered when faq is updated

application/faq/create/v1

this event is triggered when faq is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/faq/delete/v1

this event is triggered when faq is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/faq/update/v1

this event is triggered when faq is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Filter

This event will be generated where there is any action done on filter

Events

application/filter/create/v1

# this event is triggered when filter is created

application/filter/delete/v1

# this event is triggered when filter is deleted

application/filter/update/v1

# this event is triggered when filter is updated

application/filter/create/v1

this event is triggered when filter is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/filter/delete/v1

this event is triggered when filter is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/filter/update/v1

this event is triggered when filter is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Legal

This event will be generated where there is any action done on legal

Events

application/legal/update/v1

# this event is triggered when legal is updated

application/legal/update/v1

this event is triggered when legal is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Order

This event will be generated where there is any action done on order

Events

application/order/payment_failed/v1

# This event is triggered when order is payment_failed

application/order/pending/v1

# This event is triggered when order is pending

application/order/placed/v1

# This event is triggered when order is placed

application/order/payment_failed/v1

This event is triggered when order is payment_failed

Payload

application_id

array|string

Sales channel ID for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/order/pending/v1

This event is triggered when order is pending

Payload

application_id

array|string

Sales channel ID for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/order/placed/v1

This event is triggered when order is placed

Payload

application_id

array|string

Sales channel ID for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Payment

This event will be generated where there is any action done on payment

Events

application/payment/complete/v1

# this event is triggered when payment is completed

application/payment/failed/v1

# this event is triggered when payment is failed

application/payment/pending/v1

# this event is triggered when payment is pending

application/payment/complete/v1

this event is triggered when payment is completed

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/payment/failed/v1

this event is triggered when payment is failed

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/payment/pending/v1

this event is triggered when payment is pending

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Payload containing a list of payment objects related to a merchant's order.

Properties

Payload Schema JSON

Payload Example

Product

This event will be generated where there is any action done on product

Events

application/product/create/v1

# this event is triggered when product is created

application/product/delete/v1

# this event is triggered when product is deleted

application/product/update/v1

# this event is triggered when product is updated

application/product/create/v1

this event is triggered when product is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/product/delete/v1

this event is triggered when product is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Payload containing product information

Properties

Payload Schema JSON

Payload Example

application/product/update/v1

this event is triggered when product is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Payload containing product information

Properties

Payload Schema JSON

Payload Example

Promotion

This event will be generated where there is any action done on promotion

Events

application/promotion/create/v1

# this event is triggered when promotion is created

application/promotion/update/v1

# this event is triggered when promotion is updated

application/promotion/create/v1

this event is triggered when promotion is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/promotion/update/v1

this event is triggered when promotion is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Promotion usage

This event will be generated where there is any action done on promotion_usage

Events

application/promotion_usage/update/v1

# this event is triggered when promotion_usage is updated

application/promotion_usage/update/v1

this event is triggered when promotion_usage is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Refund

This event will be generated where there is any action done on refund

Events

application/refund/refund_done/v1

# this event is triggered when refund is refund_done

application/refund/refund_failed/v1

# this event is triggered when refund is refund_failed

application/refund/refund_initiated/v1

# this event is triggered when refund is refund_initiated

application/refund/refund_pending/v1

# this event is triggered when refund is refund_pending

application/refund/refund_done/v1

this event is triggered when refund is refund_done

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/refund/refund_failed/v1

this event is triggered when refund is refund_failed

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/refund/refund_initiated/v1

this event is triggered when refund is refund_initiated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/refund/refund_pending/v1

this event is triggered when refund is refund_pending

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Seo

This event will be generated where there is any action done on seo

Events

application/seo/update/v1

# this event is triggered when seo is updated

application/seo/update/v1

this event is triggered when seo is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Shipment

This event will be generated where there is any action done on shipment

Events

application/shipment/create/v1

# this event is triggered when shipment is created

application/shipment/data_update/v1

# this event is triggered when shipment is data_updated

application/shipment/update/v1

# this event is triggered when shipment is updated

application/shipment/create/v1

this event is triggered when shipment is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Event object that is being produced

Properties

payload

object

Payload produced by the OMS

Properties

Payload Schema JSON

Payload Example

application/shipment/data_update/v1

this event is triggered when shipment is data_updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/shipment/update/v1

this event is triggered when shipment is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Sort

This event will be generated where there is any action done on sort

Events

application/sort/create/v1

# this event is triggered when sort is created

application/sort/delete/v1

# this event is triggered when sort is deleted

application/sort/update/v1

# this event is triggered when sort is updated

application/sort/create/v1

this event is triggered when sort is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/sort/delete/v1

this event is triggered when sort is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/sort/update/v1

this event is triggered when sort is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Theme

This event will be generated where there is any action done on theme

Events

application/theme/create/v1

# This event is triggered when theme is created

application/theme/delete/v1

# This event is triggered when theme is deleted

application/theme/update/v1

# This event is triggered when theme is updated

application/theme/create/v1

This event is triggered when theme is created

Payload

application_id

array|string

Application ID(Sales Channel) for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/theme/delete/v1

This event is triggered when theme is deleted

Payload

application_id

array|string

Application ID(Sales Channel) for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

application/theme/update/v1

This event is triggered when theme is updated

Payload

application_id

array|string

Application ID(Sales Channel) for which this event is triggered

company_id

integer

Company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

User

This event will be generated where there is any action done on user

Events

application/user/create/v1

# this event is triggered when user is created

application/user/delete/v1

# this event is triggered when user is deleted

application/user/update/v1

# this event is triggered when user is updated

application/user/create/v1

this event is triggered when user is created

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

array of object

Array of Properties

Payload Schema JSON

Payload Example

application/user/delete/v1

this event is triggered when user is deleted

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

array of object

Array of Properties

Payload Schema JSON

Payload Example

application/user/update/v1

this event is triggered when user is updated

Payload

application_id

array|string

sales channel ID for which this event is triggered

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

array of object

Array of Properties

Payload Schema JSON

Payload Example