Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Chathive api
Introduction
Chat
Documents
Projects
Sessions
GET
verify

Chathive api

Chat

GETGet welcomes message

https://api.chathive.app/api/v1.0/chat/welcome_message?language=nl&stream=true

Get the welcome message for a specific language.
If language is not provided the default language from the project will be used.

Query parameters

  • language: ISO 639-1 language codes (optional)
  • stream: boolean value default false (optional)
    If true the response will stream the welcome message in chunks as a response

Response

Welcome message found

Stream: false

json
{
    "message": "👋 Welcome to our website! Need assistance?. Don't hesitate to start the conversation. 😊"
}

Stream: true

Streams the welcome message in parts

Stream responses can result in abnormal response in Postman.

No welcome message

status code: 404

HEADERS
x-api-key

your_api_key

PARAMS
language

nl

stream

true

Example Request
Get welcomes message
curl
curl --location 'https://api.chathive.app/api/v1.0/chat/welcome_message?language=nl&stream=true' \
--header 'x-api-key: your_api_key'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETGet lead generation fields

https://api.chathive.app/api/v1.0/chat/lead_generation/fields?language=en

Get the lead generation fields for the given language.

If language is not set, the default language will be used.

Query parameters

Response

Each fields contains the following configurations

FieldDescription
IndexOrder in which field must be displayed
KeyThe key of the field that is used when sending the lead generation back through the API
TypeThe type of input is expected
IsRequiredIf the field is required or is optional
Config.labelLabel of the field
Config.placeholderPlaceholder for the field (optional)
Config.helpTextExtra information for the customer to help them fill in the field (optional)

Reponse body

json
{
    "language": "en",
    "fields": [{
        "index": 0,
        "key": "email",
        "type": "email" | "text" | "number" | "textarea",
        "isRequired": true,
        "config": {
            "label": "Email",
            "placeholder": "johndoe@vlaio.be",
            "helpText": "Optional help text",
        },
    }],
}
HEADERS
x-api-key

your_api_key

PARAMS
language

en

Example Request
Get lead generation fields
curl
curl --location 'https://api.chathive.app/api/v1.0/chat/lead_generation/fields?language=en' \
--header 'x-api-key: your_api_key'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers