Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

# About the BI Events API

This API allows 3rd party apps connected to Wix, to send BI events to the Wix system. 
It includes several out-of-the-box events, like when the app dashboard is loaded, or when a primary action is taken (the most valuable action in an app product flow). 
If the list of built-in event does not suit your needs, you can also send a custom event.


EventName

Custom event name. Required when eventName = `CUSTOM`.

customEventName

Additional data about the event.
Supported keys: `cycle_name`, `currency`, `sum`, `reason`, `app_plan_id`.
You can submit your own keys as well.
- `cycle_name` - should be one of : `monthly`, `yearly`, `2 years`, `one time`.
- `currency` - ISO 4217 currency code.
- `sum` - required when eventName = `CHARGE` or `FUNDS_RETURNED`.
- `reason` - why the event was triggered.
- `app_plan_id` - plan ID as displayed in the Developers Center (returned as `vendorProductId` in the paid plan purchased webhook).

eventData

- `APP_DASHBOARD_LOADED` - should be fired when your app's dashboard is loaded by a site owner or contributor.
- `APP_FINISHED_CONFIGURATION` - should be fired when the site owner is completely onboarded and has completed all required configurations for the app to function properly.
- `APP_UPGRADED` - should be fired when a site owner upgrades the app to a higher plan (when the upgrade and checkout flow is done on the app side and not via Wix).
- `PRIMARY_ACTION_PERFORMED` - should be fired every time a site owner, contributor or visitor triggers the primary action in the app (for example, “review written” for a product reviews app).
- `CHARGE` - should be fired when you charge money from the site owner (for example, new purchases or subscription renewal). Make sure to also send `eventData` and a key of `sum`.
- `FUNDS_RETURNED` - should be fired when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send `eventData` and a key of `sum`.
- `CUSTOM` - should be fired for any other event which is not supported by the above. Make sure to also send `customEventName`.
- `APP_DEPLOYED` - should be fired when the app’s internal code implementation was changed and might affect user flows or cause a regression.
- `APP_FINISH_BUSINESS_SETUP` - **Deprecation Notice:** This enum will be removed on March 30, 2023. Use `APP_SETUP_FINISHED` instead;.
- `APP_SETUP_FINISHED` - should be fired when the site owner has completed the required business setup.

About the BI Events API

Permission Scopes

Syntax