POST

Send BI Event


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Submit a BI event to Wix.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Your App
Read site, business, and email details
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/apps/v1/bi-event

Body Params
eventNamestring

Name of the event that's triggered in your app.


customEventNamestringminLength 2

Name of your app's custom event that was triggered. Required when {"eventName": "CUSTOM"}.

Min: 2 characters


eventDataMap <string, string>format map

Supported values include: "cycle_name", "currency", "sum", "reason", "app_plan_id". You may also submit data with keys that aren't listed here.

Additional data about your app's event.

  • "cycle_name": Supported values: "monthly", "yearly", "2 years", "one time".
  • "currency": 3-letter currency code in ISO-4217 alphabetic format.
  • "sum": Amount of money. Required for {"eventName": "CHARGE"} and {"eventName": "FUNDS_RETURNED"}.
  • "reason": Information about why the event was triggered in your app.
  • "app_plan_id": ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as vendorProductId in the Paid Plan Purchased webhook.
Response Object
Returns an empty object.
Request
cURL
curl -X POST \ 2 https://www.wixapis.com/apps/v1/bi-event \ 3 -H 'Authorization: <AUTH>' \ 4 -d '{ 5 "eventName": "APP_DASHBOARD_LOADED", 6 }'
Response
JSON
{}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?