Skip to main content

GraphQL Contract

The widget talks to a GraphQL endpoint that must expose the Ink Live Chat operations. The endpoint you point apiUrl at — whether Kraken directly (pattern A) or your proxy (pattern B) — must ultimately resolve these operations.

The operation names and shapes must match what your installed widget version expects.

Required operations

OperationTypePurpose
InkConversationQueryPaginated conversation events (message history).
CreateInkLiveChatMessageMutationSend a message; returns the conversation relayId.
CloseInkLiveChatMutationClose the current conversation.

Validate the exact fields and input arguments against your Kraken/Ink schema for the version you run.

Backend permissions

For the widget to work end-to-end, the authenticated account user must have the roles/permissions that allow managing and querying Ink Live Chat conversations on your Kraken backend. If mutations fail with an authorization error, check that the user's role grants the required Ink Live Chat permissions.