Skip to main content
POST
/
public
/
widget-session
Create a widget session
curl --request POST \
  --url https://api.tinyinbox.app/public/widget-session \
  --header 'Content-Type: application/json' \
  --data '
{
  "siteKey": "tin_abc123",
  "visitorId": "<string>",
  "identityToken": "<string>"
}
'
{
  "settings": {
    "siteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publicKey": "<string>",
    "name": "<string>",
    "accentColor": "<string>",
    "welcomeMessage": "<string>"
  },
  "token": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "visitor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tinyinbox.co/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
siteKey
string
required
Example:

"tin_abc123"

visitorId
string
required
identityToken
string | null

Response

Widget session

settings
object
required
token
string
required
expiresAt
string<date-time>
required
visitor
object
required