Create support widget session

POST/support/widget/{key}/session

Path parameters

keystringrequired

Request body

application/json

sessionTokenstring

externalIdstring

emailstring<email>

namestring

identifierHashstring

turnstileTokenstring

Responses

200

Widget session created or resumed

sessionTokenstringrequired

ticketIdstring | nullrequired

identityVerifiedbooleanrequired

configobjectrequired

Show properties

greetingstring | nullrequired

brandColorstring | nullrequired

requireEmailbooleanrequired

customerobject | nullrequired

Show properties

emailstring | nullrequired

fullNamestring | nullrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

keypath*

Bodyapplication/json

sessionTokenstringexternalIdstringemailstringnamestringidentifierHashstringturnstileTokenstring

Request

curl -X POST '/support/widget/string/session' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionToken": "string",
  "externalId": "string",
  "email": "user@example.com",
  "name": "string",
  "identifierHash": "string",
  "turnstileToken": "string"
}'

const response = await fetch("/support/widget/string/session", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"sessionToken\": \"string\",\n  \"externalId\": \"string\",\n  \"email\": \"user@example.com\",\n  \"name\": \"string\",\n  \"identifierHash\": \"string\",\n  \"turnstileToken\": \"string\"\n}"
});

import requests

response = requests.post(
    "/support/widget/string/session",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"sessionToken\": \"string\",\n  \"externalId\": \"string\",\n  \"email\": \"user@example.com\",\n  \"name\": \"string\",\n  \"identifierHash\": \"string\",\n  \"turnstileToken\": \"string\"\n}",
)

Response

{
  "sessionToken": "string",
  "ticketId": "string",
  "identityVerified": true,
  "config": {
    "greeting": "string",
    "brandColor": "string",
    "requireEmail": true
  },
  "customer": {
    "email": "string",
    "fullName": "string"
  }
}