Get Installation Status

Check whether Chatway is installed on a website. Chatway first looks for conversations started on that domain in the last 7 days (widget_operational), then for an installed Chatway store app (script_detected, detected_by: marketplace), then for this account's script in the page HTML (script_detected). Single-page apps that add scripts after the page loads cannot be verified from the HTML and return unverified_spa. Every status other than widget_operational and script_detected means the installation is not confirmed. Allows 10 website fetches per minute per account. Checks answered from conversations or a store app do not count.

Possible status values: widget_operational, script_detected, different_account_script, unverified_spa, not_detected, check_failed, invalid_domain.

GET https://developers.chatway.app/api/v1/installation/status

Example request

curl -X GET "https://developers.chatway.app/api/v1/installation/status" \
  -H "X-API-KEY: your_api_key"

Parameters

Name	In	Required	Type	Description
`domain`	query	Yes	string	Website domain to check, such as `example.com`. A full URL is also accepted; only its host is used.

Responses

200

application/json

data (object, required)
- domain (string, required)
- status (string, required)
- script_detected (boolean, required)
- widget_operational (boolean, required)
- detected_by (string|null, required)
- last_conversation_date (string|null, required)
- message (string, required)

429

Too many installation checks. Wait for the number of seconds in the Retry-After header.

application/json

message (string, required)
retry_after (integer, required)

422

Examples

Response 200 example

{
    "data": {
        "domain": "domain",
        "status": "active",
        "script_detected": true,
        "widget_operational": true,
        "detected_by": "detected by",
        "last_conversation_date": "last conversation date",
        "message": "Conversation not found"
    }
}