Create support widget key

POST/workspaces/{organizationId}/support/widget-keys

Path parameters

organizationIdstringrequired

Request body

application/json

namestring

min length 1 · default: "Chat widget"

allowedOriginsstring[]

default: []

greetingstring | null

brandColorstring | null

requireEmailboolean

default: false

requireChallengeboolean

default: false

Responses

201

Widget key created

idstringrequired

organizationIdstringrequired

keystringrequired

hmacSecretstringrequired

namestringrequired

allowedOriginsstring[]required

greetingstring | nullrequired

brandColorstring | nullrequired

requireEmailbooleanrequired

requireChallengebooleanrequired

isActivebooleanrequired

createdBystring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/support/widget-keys' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Chat widget",
  "allowedOrigins": [],
  "greeting": "string",
  "brandColor": "string",
  "requireEmail": false,
  "requireChallenge": false
}'

const response = await fetch("/workspaces/string/support/widget-keys", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Chat widget\",\n  \"allowedOrigins\": [],\n  \"greeting\": \"string\",\n  \"brandColor\": \"string\",\n  \"requireEmail\": false,\n  \"requireChallenge\": false\n}"
});

import requests

response = requests.post(
    "/workspaces/string/support/widget-keys",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Chat widget\",\n  \"allowedOrigins\": [],\n  \"greeting\": \"string\",\n  \"brandColor\": \"string\",\n  \"requireEmail\": false,\n  \"requireChallenge\": false\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "key": "string",
  "hmacSecret": "string",
  "name": "string",
  "allowedOrigins": [
    "string"
  ],
  "greeting": "string",
  "brandColor": "string",
  "requireEmail": true,
  "requireChallenge": true,
  "isActive": true,
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}