Logo Knowledge Base Logo Knowledge Base
  • Back to Website
  • ConverseIQ Platform
Logo Knowledge Base Logo Knowledge Base
  • Back to Website
  • ConverseIQ Platform
  • Get Started
    • Quick Start Guide
    • How to Register
    • How to Login
    • Welcome
    • The Basics
    • Account Details
    • How to Reset your Password
    • Billing
    • Upgrading
    • Online Status
    • Email Settings
    • Your Own Knowledge Base
    • Deleting your account
  • Workspaces
    • Overview
    • Team and Departments
  • Widgets
    • Overview
    • Creating a new widget
    • Installing a widget
    • Embedding a Widget
    • Duplicating a widget
    • Transferring a widget
    • Deleting a widget
  • Multi-Channel Widget
    • Overview
    • Installing a multi-channel widget
    • Supported channels
    • Adding a new channel
    • Talk.to integration
    • Customisation
    • Live chat widget
  • Live Chat Widget
    • Overview
    • Installing a Live chat widget
    • Ice breakers
    • Online and offline mode
  • Unified Widget
    • Overview
    • General Configuration
    • Launcher Configuration
    • Widget Configuration
    • Unified Widget Preview
  • Omni channel chat inbox
    • Overview
    • Supported channels
    • Connect WhatsApp
    • Connect Facebook Messenger
    • Connect Instagram Messenger
    • Connect Telegram
    • Connect Line
    • Connect Viber
    • Chat shortcuts
  • Chat Flows (Chatbot Builder)
    • Overview
    • Creating a Chat Flow
    • AI Assistants
    • Creating a Chat Flow Template
    • Connecting a Channel to a Chat Flow
    • Chat flow concepts and basics
  • Form Designer
    • Overview
    • Creating a New Form
    • Embedding a Form to another Platform
  • CRM
    • Overview
  • AI Assistants and Integrations
    • Overview
    • AI Assistants with OpenAI
    • OpenAI - AI Assistant Fields
    • OpenRouter Integration
    • AI Prompt Best Practices
  • AI Tools
    • Overview
    • Prompt Generator
    • Prompt Optimiser
    • AI Assistant File Optimiser
    • AI Tools Fair Use Policy
  • AI Prompt Ideas
    • Make your AI think Independently
    • Make your AI Assistant mimic your style
    • Make your AI Assistant more Human
  • n8n Automation
    • Overview
    • n8n Fair Use Policy
  • Public API
    • Overview
    • API Reference
    • Webhooks
    • Data Types
  1. Overview
  2. Public API

Public API

  • Overview

    What is an API? An API (Application Programming Interface) lets you request or send data between systems, on demand. You control when and how the request is made. You pull data when needed Used for: fetching user profiles, sending messages, cre ...

  • API Reference

    Every request to the ConverseIQ API must include an x-api-key header containing a valid API key. You can generate an API Key by going to Settings → API settings → Add new API key, where you’ll also have the option to label it. For en ...

  • Webhooks

    Webhooks enable you to transmit data from ConverseIQ to external platforms when specific events occur. To subscribe to events, go to Settings, then API settings, and click on the "Webhook" tab. From there, add a new Webhook endpoint. In the dialog box th ...

  • Data Types

    API data types refer to the structure and format of the values sent and received in the API. These define how data should be formatted in your requests and how to interpret responses. User { "guid": "00000000-0000-0000-0000-000000000000", "e ...

© 2025 ConverseIQ
  • Privacy Policy
  • Terms of Service