eGain API Documentation

This is the complete API documentation for connecting to the eGain API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet eGain: eGain Conversation Manager APIs for managing authentications, client applications, participants, channels, orchestrations, and accounts through eGain's server-to-server OAuth2 contract. Keep reading to get started.

Quickstart

Before you run your first eGain request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one eGain connection — create or choose one in Connections. Note its connectionId.

Every eGain action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/eGain/latest/actions/{actionSlug}

You need a MindCloud API Key and a eGain connection. Then call an action such as Get Account:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/eGain/latest/actions/get-account" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected eGain account that should run the action. MindCloud stores and refreshes the eGain credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

eGain actions

All 35 published actions for this eGain version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Account
• POSTCreate Asset
• POSTCreate Authentication
• POSTCreate Channel
• POSTCreate Client Application
• POSTCreate Orchestration
• POSTCreate Participant
• DELETEDelete Account
• DELETEDelete Asset
• DELETEDelete Authentication
• DELETEDelete Channel
• DELETEDelete Client Application
• DELETEDelete Orchestration
• DELETEDelete Participant
• GETGet Account
• GETGet Asset
• GETGet Authentication
• GETGet Channel
• GETGet Client Application
• GETGet Conversation
• GETGet Orchestration
• GETGet Participant
• GETList Accounts
• GETList Authentications
• GETList Channels
• GETList Client Applications
• GETList Orchestrations
• GETList Participants
• POSTSend Message
• PUTUpdate Account
• PUTUpdate Authentication
• PUTUpdate Channel
• PUTUpdate Client Application
• PUTUpdate Orchestration
• PUTUpdate Participant

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionHubSpotGoogle Forms