BI Events: Sample flows

This article outlines key flows for sending BI events and explains their implications.

Alert users when app setup is incomplete

To alert users that your app requires additional configuration, such as setting preferences or creating an account, Wix can display a "Setup incomplete" status badge next to your app in the site dashboard.

To enable the badge, your app has to send the APP_FINISHED_CONFIGURATION event at least once. Wix will then recognize your app as requiring additional setup and show the badge for future installations. Once you determine that the app instance has completed the setup of the app, send the event for that instance to remove the badge and mark it as configuration finished.

The process looks like this:

  1. A user installs your app. At this point:
    • If you’ve sent the APP_FINISHED_CONFIGURATION event at least once, the user sees the "Status incomplete" badge next to your app in the site dashboard.
    • If you haven’t sent the event, no setup status is shown to the user.
  2. Upon opening the app, your app prompts the user to complete the setup.
  3. After setup is complete, your app sends the APP_FINISHED_CONFIGURATION event, including an OAuth access token for the relevant app instance in the Authorization header.
  4. Wix removes the "Setup incomplete" status badge next to your app in the site dashboard.

Warning: After sending the APP_FINISHED_CONFIGURATION event, your app will always show a "Setup incomplete" status for new installations. This behavior can't be disabled.

Did this help?