ReferencePublic agents and widget
Whether widget.js may show its launcher on the calling page (no sign-in; Access-Control-Allow-Origin *)
GET
/v1/public/agents/{agentId}/widget-checkChecks the publishable key, the page's origin (the Origin header, or ?origin= when the browser sends none) against the key's allowed origins, the public switch and the agent's status. Always 200 for a valid agent ID: allowed false comes with the reason (code and message) for the site owner's console. The key's allowed origins are never returned.
Path Parameters
agentId*string
Format
uuidQuery Parameters
key*string
origin?string
The page's origin, used only when the request has no Origin header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/public/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/widget-check?key=string"{ "data": { "allowed": true, "code": "string", "message": "string", "name": "string", "accentColor": "string" }}