Discord Community

API Reference

ChatDash Official Documentation

Dashboard

Support

Push one or more new messages to a conversation

Push Conversation Messages

The date and time the message was created

The type of the message, which is 'button' for ButtonMessage

Button Message

The type of the message, which is 'card' for CardMessage

Card Message

The type of the message, which is 'choice' for ChoiceMessage

Choice Message

The type of the message, which is 'debug' for DebugMessage

Debug Message

The default path of the extension message

The visibility of the extension message on the prototype

The type of the message, which is 'extension' for ExtensionMessage

Extension Message

The type of the message, which is 'file' for FileMessage

File Message

The type of the message, which is 'image' for ImageMessage

Image Message

The type of the message, which is 'location' for LocationMessage

Location Message

The type of the message, which is 'path' for PathMessage

Path Message

The type of the message, which is 'text' for TextMessage

Text Message

The type of the message, which is 'transition' for TransitionMessage

Transition Message

ChatDash - The Ultimate AI-Powered Chatbot Dashboard for Agencies

ChatDash Introduction

Leverage ChatDash's API for your custom applications and workflows.

ChatDash API Introduction

Integration ideas to get you started with the ChatDash API

Use Case Examples

Fetch Chatbots

Fetch Chatbot

Create Chatbot

Update Chatbot

Delete Chatbot

Fetch Clients

Fetch Client

Create Client

Update Client

Delete Client

Fetch Projects

Fetch Client Projects

Fetch Project

Create a new project using the given clientId/chatbotId

Create Project

Update Project

Delete Project

Fetch conversations for a project with optional filtering. By default, conversations that have the 'record' and 'interacted' fields set to true will be returned (i.e. conversations that are being recorded and have user interaction).

Fetch Project Conversations

Create a new conversation for a project. For best results, fill in as many of the fields as possible when creating a conversation object.

Create Conversation

Update a conversation's read, endedAt, record, and interacted fields

Update Conversation

Delete a conversation and its associated messages

Delete Conversation

Get Conversation Messages

Overwrite all messages for a conversation with a new array of messages

Overwrite Conversation Messages

Delete Conversation Messages

Query various metrics about a project, such as the number of conversations, the number of users, and the number of messages

Query Project Analytics

1. Adding a Chatbot

2. Adding a Client

Customize a webchat project setting in ChatDash

3. Customizing a Webchat Project Setting

4. Deploying a Project

Overview of the agency dashboard in ChatDash

Overview

Managing client dashboard access in ChatDash

Client Access

Adding a custom menu for clients in ChatDash

Custom Menus

Adding Workspaces

Generate a project usage report for client billing in ChatDash

Project Usage Report

Edit the default settings of a chatbot in ChatDash

Editing Chatbot Default Settings

Set the desired language for your agency/client dashboard in ChatDash

Language Settings

Overview of the client dashboard in ChatDash

Analytics

Conversations

Voiceflow Knowledge Base menu in client dashboard

Knowledge Base

Voiceflow Knowledge Base Tags menu in client dashboard

Knowledge Base Tags

Edit Assistant

Chat Interface

Overview of live human hands-off in ChatDash and How to enable it for your clients.

Using the API

API Reference

Push Conversation Messages

Headers

Path Parameters

Body

Response