External chat
Botyard REST API endpoints for external chat.
3 endpoints in this group. Every request authenticates with an API key; see the API reference for the other groups.
- Mint Claim Code:
POST /v1/orgs/{org_id}/external-chat/claim-codes - List External Chat Tenants:
GET /v1/orgs/{org_id}/external-chat/tenants - Update External Chat Tenant:
PATCH /v1/orgs/{org_id}/external-chat/tenants/{tenant_id}
Redeem Device Enrollment
Redeem an enrollment token, registering this machine as the bot's device. Registering the public key and consuming the token are atomic: the token is spent by a conditional UPDATE that exactly one concurrent caller can win, and the device row is written in the same transaction, so a token is never consumed without producing the device it paid for. No session, assertion or SVID is issued here. The device credential buys only the right to *ask* for one, on every future connection, against a registry that can deny it immediately. *** THERE IS EXACTLY ONE WAY TO LEAVE HERE WITHOUT A DEVICE ROW, AND IT IS AN ERROR. *** A 2xx from this endpoint means the registry holds a live, active device for the caller — either written by this call (``201``, ``newly_enrolled``) or read back within it (``200``, the machine already being that device and offering its key). The caller may therefore treat "this call succeeded" as "a device exists server-side", which is the property an installer needs and the one it cannot establish for itself.
Mint Claim Code
Mint a single-use code that links a provider tenant to this org. The plaintext is in this response and nowhere else.