Extension
Events categorised under extension level will be triggered when any action performed on extension. e.g. If extension is installed.
This event will be generated where there is any action done on extension-subscription
Events
extension/extension-subscription/create/v1
# this event is triggered when extension-subscription is created
extension/extension-subscription/update/v1
# this event is triggered when extension-subscription is updated
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
_id
string
Required
Subscription id
meta
object
Open dictionary containing any meta data regarding extension
Properties
name
string
Required
name
string
Required
Name of subscription plan
term
string
Plan tagline
price
object
Required
Properties
amount
integer
Required
Subscription amount to be deducted in each billing cycle
currency_code
string
Required
Subscription amount currency ISO code
status
string
Required
Current status of subscription. Possible values: pending, active, declined, no_renew, cancelled, frozen
is_test
boolean
Required
Flag to indicate charges are test charges
recurring
object
Properties
interval
string
Required
Specifies the duration of the plan
interval_time
integer
Required
Signifies recurring time periods
created_at
string
Required
ISODate subscription creation date
trial_days
integer
Required
Number of trial days allowed in current subscription
modified_at
string
Required
ISODate subscription latest updation date
activated_on
string|null
Required
ISODate string for subscription activation (Null when in pending state)
cancelled_on
string|null
Required
ISODate string for subscription cancelled state (Null until moved to cancelled state)
extension_id
string
Extension ID
pricing_type
string
Required
Pricing type for current extension charge (It will be always `recurring` for subscription)
capped_amount
integer
Required
Max usage allowed under current extension charge
subscriber_id
string
Required
Subscriber id for fynd platform Seller/company owner
current_period
object
Current time period of subscription
Payload Schema JSON
Loading...
Payload Example
Loading...
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
_id
string
Required
Subscription id
meta
object
Open dictionary containing any meta data regarding extension
Properties
name
string
Required
name
string
Required
Name of subscription plan
term
string
Plan tagline
price
object
Required
Properties
amount
integer
Required
Subscription amount to be deducted in each billing cycle
currency_code
string
Required
Subscription amount currency ISO code
status
string
Required
Current status of subscription. Possible values: pending, active, declined, no_renew, cancelled, frozen
is_test
boolean
Required
Flag to indicate charges are test charges
recurring
object
Properties
interval
string
Required
Specifies the duration of the plan
interval_time
integer
Required
Signifies recurring time periods
created_at
string
Required
ISODate subscription creation date
trial_days
integer
Required
Number of trial days allowed in current subscription
modified_at
string
Required
ISODate subscription latest updation date
activated_on
string|null
Required
ISODate string for subscription activation (Null when in pending state)
cancelled_on
string|null
Required
ISODate string for subscription cancelled state (Null until moved to cancelled state)
extension_id
string
Extension ID
pricing_type
string
Required
Pricing type for current extension charge (It will be always `recurring` for subscription)
capped_amount
integer
Required
Max usage allowed under current extension charge
subscriber_id
string
Required
Subscriber id for fynd platform Seller/company owner
current_period
object
Payload Schema JSON
Loading...
Payload Example
Loading...
Was this section helpful?
Events
extension/extension/install/v1
# this event is triggered when extension is installed
extension/extension/uninstall/v1
# this event is triggered when extension is uninstalled
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
company
object
Required
Properties
id
integer
Required
Company id where extension is being installed or uninstalled
name
string
Required
Name of company where extension is installed or uninstalled
email
string
Required
Company's primary contact email
extension
object
Required
Properties
id
string
Required
Extension ID or API_KEY
name
string
Required
Extension name
base_url
string
Required
Extension launch url
extension_type
string
Required
Type of extension private/public
organization_id
string
Required
Extension Creator - Partner Organization id
installed_on
string
Required
Date ISOString on extension is installed. (Only present for install type event)
Payload Schema JSON
Loading...
Payload Example
Loading...
Was this section helpful?
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
extension
object
Required
Properties
id
string
Required
Extension ID or API_KEY
extension_type
string
Required
Type of extension private/public
name
string
Required
Extension name
base_url
string
Required
Extension launch url
organization_id
string
Required
Extension Creator - Partner Organization id
company
object
Required
Properties
id
integer
Required
Company id where extension is being installed or uninstalled
name
string
Required
Name of company where extension is installed or uninstalled
email
string
Required
Company's primary contact email
uninstall_message
string
Required
Seller submittted reason for uninstalling extension (Only present for uninstall type event)
uninstalled_on
string
Required
Date ISOString on extension is uninstalled. (Only present for uninstall type event)
Payload Schema JSON
Loading...
Payload Example
Loading...
Was this section helpful?