How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
8x8

Contact Center Chat Gateway

8x8 Contact Center Chat Gateway API for bridging external chat channels into 8x8 Contact Center conversations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Contact Center Chat Gateway is one of 36 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contact Center, Chat, and Gateway. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 34 operations across 23 paths, organized into 8 resource areas, and defines 64 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.8x8.com.

34 operations 23 paths 64 schemas 2 DELETE15 GET2 PATCH10 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.8x8.com
Authentication
API Key
Contact
cc-cluj-iris@8x8.com
Resource Areas
8

Authentication & Security 1

Contact Center Chat Gateway declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (8x8ApiKey).

Paths & Operations 34

Across 23 paths, the API surfaces 34 operations — 2 DELETE, 15 GET, 2 PATCH, 10 POST, 5 PUT. They span 8 resource areas: WebHooks, JwkKeys, Channels, Conversations, Participants, Messages, Attachments, Cards. Each is listed below with its method, path, parameters, and response codes.

WebHooks 6

Enables webhook definitions that can be associated to channels.

GET
/chat-gateway/v1/webhooks
Retrieves all customer webhooks based on the associated token information.
getwebhooks-1 5 params → 200400401403500default
POST
/chat-gateway/v1/webhooks
Creates a new customer webhook.
createwebhook-1 1 param body → 200400401403500default
GET
/chat-gateway/v1/webhooks/{webhookId}
Get webhook by Id.
getwebhookbyid-1 2 params → 200401403404500default
PUT
/chat-gateway/v1/webhooks/{webhookId}
Updates the full webhook resource by Id.
updatewebhook-1 2 params body → 200400401403404500default
DELETE
/chat-gateway/v1/webhooks/{webhookId}
Deletes the webhook by Id.
deletewebhookbyid-1 2 params → 204401403404500default
POST
/chat-gateway/v1/webhooks/verify
The endpoint used to validate that the webhook is working and reachable.
verifywebhook-1 1 param body → 204400401403500default
JwkKeys 1

An API that offers JWK public key access to customers.

GET
/chat-gateway/v1/jwk/{jwkId}/public
Returns the public JWK.
getjwkpublickey-1 2 params → 200404500default
Channels 5

Enables ChatAPI channel registration and association with a webhook containing channel.

GET
/chat-gateway/v1/channels
Retrieves all customer Chat API channels.
getchatapichannels-1 5 params → 200400401403404500default
POST
/chat-gateway/v1/channels
Creates a channel.
createchatapichannel-1 1 param body → 200400401403500default
GET
/chat-gateway/v1/channels/{channelId}
Get ChatAPI channel by Id.
getchatapichannel-1 2 params → 200401403404500default
PUT
/chat-gateway/v1/channels/{channelId}
Update ChatAPI channel by Id.
updatechatapichannel-1 2 params body → 200400401403404500default
DELETE
/chat-gateway/v1/channels/{channelId}
Delete ChatAPI channel by Id.
deletechatapichannelbyid-1 2 params → 204401403404500default
Conversations 10

Provides Contact Center interaction capabilities.

GET
/chat-gateway/v1/conversations
Returns all conversations belonging to the customer.
getcctransactions-1 5 params → 200400401403500default
POST
/chat-gateway/v1/conversations
Creates a new conversation.
createcctransaction-1 1 param body → 202401403400500default
PUT
/chat-gateway/v1/conversations/{conversationId}
Update a conversation details.
putcctransaction 2 params body → 202401403404500default
PATCH
/chat-gateway/v1/conversations/{conversationId}
Patch a conversation details.
patchcctransaction 2 params body → 202401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}
Retrieves conversation details.
getcctransaction-1 2 params → 200401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}/interactions
Returns all conversations belonging to the customer.
getccinteractions 2 params → 200400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/post-agent-assignment
Creates a post agent assignment for a conversation.
createpostagentassignment 1 param body → 201400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/typing
Creates a typing indicator for a conversation.
sendtypingindicator 1 param body → 204400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/thinking
Sends a thinking indicator for a conversation.
sendthinkingindicator 1 param body → 204400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/read-receipt
Sends a read receipt for a conversation.
sendreadreceipt 1 param body → 204400401403404500default
Participants 2

Enables participants access control.

GET
/chat-gateway/v1/conversations/{conversationId}/participants
Retrieve the conversation participants.
getparticipantsforcctransaction-1 2 params → 200400401403500default
PATCH
/chat-gateway/v1/conversations/{conversationId}/participants/user
User leaves conversation.
userparticipantleavecctransaction 2 params body → 204401403404500default
Messages 3

Allows adding and retrieving messages of a conversation.

GET
/chat-gateway/v1/conversations/{conversationId}/messages
Retrieves the conversation messages.
getmessagesforcctransaction-1 5 params → 200400401403500default
POST
/chat-gateway/v1/conversations/{conversationId}/messages
Send a message.
sendmessagetocctransaction-1 2 params body → 202400401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}/messages/{messageId}
Retrieves the conversation messages.
getmessagebyidforcctransaction 3 params → 200401403404500default
Attachments 4

Allows adding and retrieving attachments of a conversation.

GET
/chat-gateway/v1/conversations/{conversationId}/attachments
Get attachments in Conversation.
getconversationattachments 6 params → 200400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/attachments
Add an attachment.
addconversationattachments 2 params body → 200401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}/attachments/{attachmentId}
Get an attachment from Conversation.
getconversationattachment 3 params → 200401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}/attachments/{attachmentId}/content
Download attachment.
downloadattachmentforchatapiconversation 3 params → 200401403404500default
Cards 3
GET
/chat-gateway/v1/conversations/{conversationId}/messages/{messageId}/cards
Retrieves the list of conversation message cards.
getcardsforcctransaction 6 params → 200400401403500default
PUT
/api/v1/tenant/{tenantId}/conversations/{conversationId}/cards/{cardId}/action-submit
Sends the adaptive card action submit.
updatecardactionsubmit 3 params body → 204400401403404500default
PUT
/api/v1/tenant/{tenantId}/conversations/{conversationId}/cards/{cardId}/action-execute
Sends the adaptive card action execute.
updatecardactionexecute 3 params body → 204400401403404500default

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are AdaptiveCards (5 properties), AttachmentResult (4 properties), ConversationParticipant (4 properties), UnauthorizedProblem (3 properties). Each schema is shown below with its type and property counts.

PageResult
object
1 property
Links
object
1 property
ChannelIdentifierField
object
1 property
AssignmentField
object
1 property
WebHookIdentifierField
object
1 property
ChannelTypeField
object
1 property
ConversationIdentifierField
object
2 properties
ConversationUserData
object
1 property
AttachmentsResult
AttachmentResult
object
4 properties 5 required
MessageListResult
CardsListResult
ConversationParticipants
ConversationParticipant
object
4 properties
MessageResult
WebHooksV2ListResult
ContentType
string
Card content type.
WebHookV2CreateRequest
WebHookV2PutRequest
WebHookV2VerifyRequest
WebHookV2Result
ChannelsV2ListResult
ChannelV2Result
ChannelV2CreateRequest
ChannelV2PutRequest
Language
string
The language of the user. Based on this property the user is assigned to an agent who speaks their language. The default value is English (en). The sender lang…
ExternalAuthorType
string
PostAgentAssignmentType
object
1 property
AuthorType
CreateTransactionRequest
PostAgentAssignmentRequest
TypingRequest
ReadReceiptRequest
object
2 properties 2 required
ThinkingIndicatorRequest
object
Request body for the thinking indicator. All fields are optional with defaults.
2 properties
PostAgentAssignmentConfigurationRequest
object
1 property
PatchUserParticipantRequest
object
1 property
PatchTransactionRequest
UpdateTransactionRequest
InteractionsListResult
ConversationListResult
ConversationResult
ChannelRoutingOptions
object
1 property 1 required
InteractionInfo
object
3 properties
Attachments
object
1 property
Cards
object
1 property
AdaptiveCards
object
5 properties
ExternalProviderPayload
object
External provider information for message rehydration. Required when text is not provided. Both text and externalProvider cannot be provided at the same time.
2 properties 2 required
SendConversationMessagePayload
SendConversationMessageWithExternalProviderPayload
AdditionalPropertiesPayload
AdaptiveCardActionSubmitPayload
AdaptiveCardActionExecutePayload
GenericExceptionPayload
object
2 properties
InvalidParameterExceptionPayload
object
3 properties
ResourceNotFoundExceptionPayload
object
2 properties
ValidationExceptionPayload
ConstraintViolationProblem
object
3 properties
OAuthConstraintViolationProblem
object
2 properties
ForbiddenViolationProblem
object
2 properties
UnauthorizedProblem
object
3 properties
BadRequestProblem
object
3 properties
ResourceNotFoundProblem
object
2 properties
EventVersionIdentifierField
object
1 property
EventVersion
string
Event API version.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-actions-events-contact-center-chat-gateway-v1.yml Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Contact Center Chat API V2
AE Profile APIs.io
8x8 Contact Center Dynamic Campaigns
AE Profile APIs.io
Contact Center Campaigns API
AE Profile APIs.io
Chapi - Chat API
AE Profile APIs.io
Contact Center Agent Status API
AE Profile APIs.io
8x8 Contact Center Call API Reference
AE Profile APIs.io
8x8 Administration - Address Management API
AE Profile APIs.io
8x8 Administration - Operations API
AE Profile APIs.io
8x8 Administration - Phone Number Management API
AE Profile APIs.io
8x8 Administration - Ring Group Management API
AE Profile APIs.io
8x8 Administration - Site Management API
AE Profile APIs.io
8x8 Administration - User Management API
AE Profile APIs.io
#Contact Center#Chat#Gateway
← Back to C APIs
API Details
ID
8x8:8x8-actions-events-contact-center-chat-gateway-v1
Base URL
https://api.8x8.com
Docs
https://developer.8x8.com/actions-events
Provider
8x8
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=8x8-actions-events-contact-center-chat-gateway-v1&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/8x8-actions-events-contact-center-chat-gateway-v1"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Contact Center Chat Gateway, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.