prod - 20261013-083619 - cb7f8b630deb7a27a85ea2f9e79ca9d2dcc1341f

Channel API

The Seamly Channel API provides a public API to create a direct integration with Seamly. For example to integrate Seamly in your native iOS or Android apps. If the Seamly Web-UI with its SDK doesn't suite your needs, this API allows you to completely implement and style a chat window yourself.

The Channel API provides everything that's required to implement a full-fledged chat client.

Requirements

To use the Channel API you'll need the following:

  • A Seamly API key for either the User Acceptance Testing (UAT) or the production environment
  • A list of enabled locales (ie: "en-GB" and "nl-informal")
  • At least one API channel must be configured for your Seamly account
  • The name of the channel(s) available for the Channel API. Usually there's only one channel configured. (ie: "api")

UAT and production environment

We provide two environments for you to connect to: a User Acceptance Testing (UAT) and a production environment. The base URLs of these environments are:

  • UAT: https://api.uat.seamly-app.com/channels/api/v2
  • Production: https://api.seamly-app.com/channels/api/v2

OpenAPI and AsyncAPI specifications

The Channel API provides a REST API to setup the conversation, and provides a websocket endpoint to handle all messages from and to Seamly. All messages sent over the websocket are text frames with JSON encoded data.

Please have a look at the  OpenApi specification  of the REST API and  AsyncAPI specification  of the websocket endpoint.

The deprecated Channel API v1 specifications are still available until January 15th 2026. See  OpenApi specification v1  of the REST API and  AsyncAPI specification v1 .

There's also a newer v3 version available in Beta. Use this at your own risk as the specifications might still change. See  OpenApi specification v3  of the REST Api and  AsyncAPI specification v3 .

Definitions

  • Service : A bot or livechat backend. A conversation is connected to a single service and may switch between services. Digital CX and Inbenta Hyperchat are some examples of services Seamly integrates with.

Next up