JavaScript
Widgets
Delete a widget
Gone for good. The hostname stops serving and every session on the widget is revoked.
DELETE
JavaScript
The permanent exit. Deleting a widget stops its hostname at the edge and revokes all of its sessions, so embedded widgets on customer pages go dark.
The label does not come back
DNS labels are globally unique and generated once. Deleting a widget does not free its label for reuse; a replacement widget gets a fresh hostname, and every page embedding the old one needs the newinfo.host.
That is the argument for archive instead: an archived widget keeps its label, and unarchiving brings the same hostname back. Reach for delete when the widget is truly retired, not paused.
Conversations survive
Deleting a widget removes the widget and revokes its sessions. The conversations those sessions created stay in the workspace as objectives. For erasure of a tenant’s conversations, use delete all of a tenant’s widget sessions.Related
Archive a widget
The reversible version that keeps the hostname.
Delete a tenant's sessions
Erasure that takes the conversations too.
Create a widget
The replacement, with a new hostname.
List widgets
What is left after the cleanup.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
Example:
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Widget ID. Accepts the canonical wgt_… form or the external_id:<value> form.