Error Events

max_sessions_exceeded

Emitted when the number of co-editing sessions created in a month has exceeded the monthly session quota of the subscribed plan.

//emitted whenever it is over the montly quota
codox.on('error', function (data) {
  if (data.type === 'max_sessions_exceeded') {
  }
});

We allow for some overages to allow your service to fall back gracefully.

To resolve this error, you can upgrade to a higher tier plan or wait till the month ticks over.

session_full

Emitted when a user is attempting to connect to a co-editing session that has reached the maximum number of allowed users, as determined by the subscription tier.

//emitted whenever remote changes have updated the document
codox.on('error', function (data) {
  if (data.type === 'session_full') {
  }
});

For instance, if the current subscription allows up to three users in a session, this error will be emitted if the fourth user tried to join the session from invoking either codox.init() or codox.start().

subscription_expired

Emitted when your team’s subscription has expired, but we are unable to automatically renew the subscription using the provided payment method.

//emitted whenever the subscription has expired
codox.on('error', function (data) {
  if (data.type === 'subscription_expired') {
  }
});

subscription_stopped

Emitted when your team’s subscription has stopped at the end of the subscription month as requested.

//emitted whenever the subscription has been stopped
codox.on('error', function (data) {
  if (data.type === 'subscription_stopped') {
  }
});

trial_expired

Emitted when the trial period for the app integration has expired.

//emitted whenever the trial period has expired
codox.on('error', function (data) {
  if (data.type === 'trial_expired') {
  }
});

validation_error

Emitted when your subscription cannot be validated.

//emitted whenever your subscription cannot be validated
codox.on('error', function (data) {
  if (data.type === 'validation_error') {
  }
});

Login to your account dashboard to check that you have a subscription for the app. Also confirm the apiKey and domains in the app configurations are as registered in the dashboard.