Help & Support
Our help database contains answers to most of the common questions regarding our products.
If you are unable to locate a satisfactory answer for your query by searching here, please contact us.
I lost my Cbox embed code. Where can I get it?
Your Cbox embed code is available at your control panel. You need this code to install your Cbox on your website.
Also on that page is your Quick Link — a URL which you can use to access your Cbox directly in your browser or on your mobile device.
How do I put my Cbox on my website?
Once you have created your Cbox account, go to the Publish page of your control panel. The code and steps for embedding your Cbox are provided there for a number of common platforms.
If you install your Cbox and all you see is code, or nothing at all, your web host may be removing or otherwise interfering with the HTML iframe tags that Cbox uses. Your Cbox code needs to be pasted into an area of your site that accepts HTML without modification. This may mean switching your editor from "rich text" or "WYSIWYG" mode into HTML-editing or "raw" mode, or you may need to open your template files in a plain-text editor like Notepad.
Remember that you always have the option of posting or sharing your Cbox Quick Link — this gives visitors direct access to your Cbox in a full-screen layout, so it's perfect as a mobile option or for stand-alone use.
How do change my Cbox's style to go with my site's design?
Go to the Theme editor in your control panel. There you can specify the fonts and colours of your Cbox, using a point-and-click editor. You can always reset your theme to one of the preset defaults there, if you would like to start again.
If you have a Premium or Pro Cbox you can edit CSS, which gives you complete control over presentation.
How do I delete messages?
If you have a Premium or Pro Cbox, you can create a moderator name for yourself at your Users page, and then log in on your Cbox using the "profile" link. You will see a delete icon [x] next to each message in your Cbox, and you will not have to log in at your control panel at all to delete messages.
Alternatively, visit your Messages page to delete messages individually or in bulk. Deleted messages are removed from your public Cbox history, but are preserved in your Archives.
Can I make my Cbox transparent?
Yes. In the Theme editor, simply delete the colour codes for the main and form background ("BG") elements. This will make the Cbox transparent, allowing whatever is behind the Cbox to show through.
Note that any pop-ups generated by a transparent Cbox will have the default background colour — usually white. If your font colour is light, it may be invisible in popups. You can fix this by editing the CSS to introduce a background-color rule for popups.
Push notifications
We're excited about this feature, but please note that the technology that supports it is relatively new; there are some limitations and there may be some disruptions as we work on it in future.
You will often want to know when a message has been posted on your Cbox while you have been away from the chat. Today on Android smartphones and tablets using Chrome browser, and for Chrome on the desktop, it's possible to subscribe for push notifications for Cbox messages.
This feature is only available to paid Cboxes, at your Quick Link, and for technical reasons it's only available when the page is loaded over SSL/TLS. Your browser address bar should start https://my.cbox.ws/[your_Cbox_name]
Note: If you accidentally click "deny" to the browser permission request, you will need to reset your browser's privacy settings: in Chrome, delete the Cbox entry at chrome://settings/content
under "Notifications" -> "Manage exceptions..."
If you see the bell icon at the top right, you are all set: click or tap the bell to subscribe. The first time you do this, your browser will ask permission to send you notifications on behalf of Cbox. Once we have subscribed you, the bell icon will change — you can click it again to unsubscribe from this Cbox.
Once you are subscribed for notifications, you will receive messages in your device's notification bar whenever new messages are posted to your Cbox. This will work even if the tab is closed. On desktop, Chrome may need to be running but you will not need to have Cbox open in any window.
You can have multiple subscriptions for different Cboxes and you will receive notifications for each. We combine notifications for channels and also rate-limit them to minimize potential disruption.
We are looking forward rolling this important feature out to more browsers and devices in future. Your feedback is invaluable during this process — let us know what you think.
User Integration
You need some development experience to make use of this feature, with the ability to edit your site's back-end code.
Cbox Pro supports Integration, which is a way to implement single sign-on. If users already log in or register with your site, Integration means they don't have to enter their name again on your Cbox.
Configure Integration at your control panel. Example code is available there. The rest of this article deals with general concerns.
How it works
Integration is implemented using query string parameters appended to the Cbox iframe URL. The final parameter is a signature generated from the rest of the URL. You don't need any external components or callbacks, just language support for HMAC-SHA256, base64-encoding, and url-encoding.
The signature is important to secure the generated URL against tampering by the user or any other intermediary. However, most back-end platforms have built-in support for the necessary functions.
Integrating avatars and profile links
The only required parameter is nme
, for the user's name, and the signature, sig
. But you can also pass lnk
and pic
parameters to Cbox, to take advantage of name links and avatars, respectively. These should be provided as absolute URLs. For example, https://yoursite.example.com/path/to/image.gif
. Note that the respective display settings need to be enabled for name links or avatars to show up.
Integrating with mod/admin permissions
Integrated users' names will be registered with Cbox automatically, if they aren't already. This means you can confer mod/admin permissions at your Users page.
You can also use Integration with Moderated chat. With Moderated mode enabled, your Integrated users by default will not have voice permission. You will be able to review their messages as a mod or admin user in your Cbox and approve them accordingly.
Security
Note that if you have existing users registered before enabling Integration, they are authenticated by Integration regardless of their password. This means if you have an existing "admin" user registered with a password on your Cbox, and you then enable Integration, the corresponding user named "admin" on your site will get that name (and permission). This can be an advantage, but if it's a risk in your case, delete all registered users before enabling Integration.
The signature in the Integrated Cbox URL protects the name and other information in transit. However, if you are concerned about leaked URLs, you can limit URL validity by passing an additional (signed) query string parameter, valid_to
, which should be set to a UNIX timestamp. The URL will stop working after the time specified.
You can also change the key used to generate the signature, by changing your security tag. This invalidates all your Cbox URLs, but requires that you change your published Cbox embed code accordingly.
Debugging
If you get an error in your Cbox saying that there's a problem with Integration, the most common cause is an invalid signature.
The first thing to do is right-click and inspect the Cbox iframe URL. You should have nme=...&sig=...
parameters populated in the query string. If not, check that your embed code is in place and being parsed without errors.
If the sig
parameter is present in the URL, confirm that it is being generated using the correct secret key. The key is available at your Integration page.
Ensure that you are url-encoding your query string parameters exactly once, and encoding before calculating the signature. The signature itself must then also be url-encoded, and appended to the URL. If you see the sequence %25XX
in the URL, that's a sign that you might be applying url-encoding to already url-encoded strings.
If you are still getting errors, contact us including the code you are using and an example URL, and we should be able to assist.
How can I post a link or image in my Sticky message?
The Sticky message accepts boxcode, even if you have not enabled boxcode for ordinary messages. So to post a link, enter the following:
[url=https://mysite.com]This is a link[/url]
You can post an image as well:
[img=https://mysite.com/path/to/image.jpg]Description[/img]
See this article for a complete boxcode reference.
How do I find out who posted in my Cbox?
Cbox cannot identify your visitors, but we do record IP addresses. Your Messages page makes them available to you, and you can also ban people from posting in your Cbox from that page.
Commands
There are a number of commands you can enter in your Cbox to perform actions that would otherwise require a tap or click, or that are not available through other means.
Note that commands are not formally supported by Cbox, and are liable to change, or not to function, at any time.
Enter commands as if they were messages in your Cbox:
- //debug [watch] — shows debugging information.
- //reload [clean] — refreshes the Cbox iframe. Enter //reload clean to clear local data. (This will log you out and reset preferences.)
- //ignore joe — ignore the user joe. Leave out the name to get a list of currently-ignored users. Repeat the command with an ignored name to un-ignore that person.
- //pm mary hello! — sends hello! to the user called mary. (Requires private messaging to be enabled.)
- //colors — open a colour palette to change your message text colour (requires boxcode to be enabled.)
- //tetris, //sudoku, //wordsearch game-id — for wordsearch, invite another user to enter the same command, with the same game-id, to join your game.