Sign in
Widgets

Bootstrap widget visitor

Mints a signed anonymous visitor id and returns it with the widget's presentation configuration. No credential is required.

The client presents the minted id as X-Visitor-Id on /v2/agent_aliases/{alias_key}/end_user_sessions requests, using the alias_key returned here; the widget connector the id was minted through travels inside it.

Returns 404 if the alias does not front a widget connector, or that connector is disabled, does not have public_access enabled, or belongs to a disabled customer.

The visitor id never expires. Store it durably; a repeat call mints a fresh identity that owns none of the previous identity's sessions.

post/v2/widgets/{alias_key}/bootstrap

Path parameters

alias_keystring required

The platform-generated key of the alias fronting a widget connector, as reported in the connector's alias_key and bootstrap_path. Always als_-prefixed; the prefix is reserved, so no operator-chosen alias ever matches it.

Example:als_9f3a1c2b-4d5e-6f70-8192-a3b4c5d6e7f8_00aa

The platform-generated alias the widget fronts, as carried by the embed snippet.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

A minted visitor identity and the widget's presentation configuration.

visitor_idstring

The anonymous identity minted for this visitor. Present only when the widget admits anonymous visitors; a sign-in-only widget returns no visitor_id, and its callers open a session with a customer-IdP token instead. Presented as the X-Visitor-Id header on every end-user session request. Store it durably on the client; it never expires, and it is the only proof of ownership of the sessions it creates.

alias_keystring required

The unique key that identifies an alias. Alias keys are independent of agent keys. The same string can exist as both an alias key and an agent key in the same customer account. Calls to /v2/agent_aliases/{key}/... target the alias. Calls to /v2/agents/{key}/... target the agent.

Example response

{
  "alias_key": "support",
  "presentation": {
    "version": "beta"
  },
  "end_user_sign_in": {
    "trusted_token_issuer_id": "tki_9Kx2QpVn4mZr8YbLc5TdWe"
  }
}

Changes

No recorded changes to this endpoint across all 7 revisions of this API.