Skip to main content
POST
Create embed session

Authorizations

x-api-key
string
header
required

Your ps_ API key

Body

application/json
surface
string
required

Microfrontend to embed.

Example:

"chat"

allowedOrigins
string[]
required

Exact origins (scheme://host[:port]) where the iframe may run.

Example:
whatsappNumberIds
string[]

Numbers to expose in chat (required for a tenant key on surface:chat).

Example:
brandingOverride
object

Per-session branding (logo/colors/title) overriding the tenant branding.

ttlSeconds
string

Token validity in seconds (default 900 chat / 1800 connect).

Example:

"900"

Response

Create chat session