botbar

Widget reference

Attributes, the JavaScript API, sizes, themes and languages.

AttributeOptionMeaning
data-sitekeysitekeyRequired.
data-actionactionNames the form (login, signup); returned by siteverify and used for per-action levels. Letters, digits, - and _, up to 32.
data-cdatacdataYour own data, returned by siteverify. Up to 255 of the same characters.
data-themethemeauto (default), light or dark.
data-sizesizenormal (300×65), compact (150×140) or invisible.
data-languagelanguageA language tag such as de or pt-BR. Default: the visitor's browser language.
data-response-field-nameresponseFieldNameName of the hidden field (default botbar-response); false adds none.
data-callbackcallbackCalled with the token.
data-expired-callbackexpiredCallbackThe token expired (after 5 minutes); a new one follows automatically.
data-error-callbackerrorCallbacknetwork, failed, invalid-sitekey or invalid-hostname.

Puzzles

When a puzzle is needed it opens over the page, whatever the widget's size, and closes when it's solved or cancelled.

Languages

32 languages: ar, bn, cs, da, de, el, en, es, fa, fi, fr, he, hi, hu, id, it, ja, ko, ms, nb, nl, pl, pt, ro, ru, sv, th, tr, uk, vi, zh-CN, zh-TW. Arabic, Hebrew and Persian lay out right to left.

Content Security Policy

Allow the API origin in script-src and frame-src.

On this page