ROroxels
embed

Create Embed Session

Create a person + interview + session in a single call for embed integrations.

Returns the session_id and embed URL ready to pass to the Roxels.open() JS SDK.

post/v1/embed/sessions

Request

Request body

template_idstring required
external_idstring nullable
person_namestring
person_emailstring nullable
person_metadataobject
channelstring
contextobject nullable

Response

Successful Response

session_idstring required
interview_idstring required
external_idstring nullable
embed_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.