Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

options

SendBiEventOptions

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { biEvents } from '@wix/app-market';

const wixClient = createClient({
  modules: { biEvents },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function sendBiEvent(options) {
  const response = await wixClient.biEvents.sendBiEvent(options);
}

sendBiEvent() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { biEvents } from '@wix/app-market';

const wixClient = createClient({
  modules: { biEvents },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function sendBiEvent(options) {
  const response = await wixClient.biEvents.sendBiEvent(options);
}

sendBiEvent() with Dashboard app access

sendBiEvent

void

To use the BiEvents API, install the `@wix/app-market` package using npm or Yarn:
  ```console
npm install @wix/app-market
```

or

```console
yarn add @wix/app-market
```

Then import `{ biEvents }` from `@wix/app-market`:

```js
import { biEvents } from '@wix/app-market'
```
  

app-market_bi-events

EventName

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

Min: 2 characters

customEventName

string

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](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) 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 the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).

eventData

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

+ `"APP_DASHBOARD_LOADED"`: A site onwer or contributor loads your app's dashboard.
+ `"APP_FINISHED_CONFIGURATION"`: The site owner completes all required configurations for your app in the Wix Developers Center.
+ `"APP_UPGRADED"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.
+ `"PRIMARY_ACTION_PERFORMED"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.
+ `"CHARGE"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.
+ `"FUNDS_RETURNED"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`.
+ `"CUSTOM"`: Any event that's not listed here. Make sure to also send `customEventName`.
+ `"APP_DEPLOYED"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.
+ `"APP_FINISH_BUSINESS_SETUP"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead.
+ `"APP_SETUP_FINISHED"`: The site owner completes your app's required business setup.

Setup

Permission Scopes