Sendity Client
Client attributes and public extension points.
Attributes are the stable browser-facing contract for the Sendity Web Client. They describe rendering preferences, public app identity and timing behavior — never secrets or channel destinations that belong on the server.
Use this page as a reference when converting generated markup into hand-written templates or adapter options. If an option changes security behavior rather than UI behavior, it probably belongs in your server or framework adapter configuration.
Implemented attributes
Reference-style overview of the public attributes supported by the Sendity Client and Laravel adapter.
| Attribute | Type | Default | Description |
|---|---|---|---|
public-key |
string | Required | Public app id sent when creating the challenge. |
server-url |
URL | https://sendity.io/api | Sendity API base. Hosted integrations can omit it; set it only for self-hosted APIs. |
transport |
auto | push | polling | auto | Use auto for normal integrations, push to require realtime, or polling when WebSocket infrastructure is intentionally unavailable. |
lang |
BCP 47 language tag | browser locale | Language and direction hint. Version 0.3.3 bundles English fallback copy; provide localized copy through translations. Attribute changes recompute direction and copy, then remeasure the stable state height. |
translations |
JSON object | none | Host-provided overrides with optional lang, dir, ui, and templates keys. Invalid JSON, unknown keys, oversized payloads, and non-string values are ignored. |
variant |
card | modal | card | Both use the same card and state renderer. Modal adds an overlay, focus handling and public open/close controls. |
position |
center | top | bottom | center | Controls modal placement and entry motion. |
open |
boolean | off | Opens modal variants. Control it with the open(), close(), and toggle() methods. State changes emit sendity:opened and sendity:closed. |
authenticated-event-delay-ms |
number | 2000 | Delay before firing sendity:authenticated after visual success. |
demo-mode |
boolean | off | Static preview mode for docs/editors: renders fixture data without creating AuthRequests, push subscriptions, or polling. |
demo-state |
loading | waiting | warning | error | expired | verified | waiting | Preview-only state used together with demo-mode. |
demo-channel |
email | phone | Preview-only channel. Phone demonstrates separate SMS and RCS recipients. | |
demo-drawer |
closed | instruction | ready | countdown | processing | state default | Preview-only Drawer state used together with demo-mode. |