Skip to navigation

Create an anonymous widget session for a configured integration and allowed origin.

Create an anonymous widget session for a configured integration and allowed origin.

Query parameters

workspaceIdstringRequired
Workspace identifier
integrationstringOptional
Widget integration identifier. Otherwise environment must identify exactly one enabled integration.
environmentstringOptional
Environment for integration lookup

Request

This endpoint expects an object.
dynamicVariablesmap from strings to anyOptional

Response

Session capability and HTTP message / WebSocket reply paths.

Errors

403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error