Knowledge bases

Creating a new knowledge base

POST https://api.groovehq.com/v1/kb

Parameters

Name	Type	Required	Default	Notes
subdomain	string	Yes		The unique subdomain of the knowledge base.
title	string	Yes		The title of the knowledge base.
theme_id	integer	Yes		The Theme ID for the knowledge base.
custom_domain_letsencrypt	boolean	No		Whether to use Groove provided certificates with LetsEncrypt. custom_domain must be provided.
custom_domain	string	No		Custom domain of the knowledge base.
ga_anonymized	boolean	No	false	Whether to anonymize Google Analytics tracking. ga_code must be provided.
ga_code	string	No		Google Analytics tracking code.
ip_addresses_enabled	boolean	No	false	Whether the knowledge base IP address protection is enabled.
ip_addresses	array	No		The array of IP addresses to protect with. ip_addresses_enabled must be enabled.
language	string	No	en	The RFC 5646 locale code of the knowledge base.
meta_description	string	No		The meta tag description of the knowledge base.
meta_robots	string	No	INDEX,FOLLOW	The meta robots values of the knowledge base.
og_description	string	No		The open graph meta description of the knowledge base.
og_image_url	string	No		The URL to the open graph meta image of the knowledge base.
og_title	string	No	`title`	The open graph title of the knowledge base.
page_title	string	No	`title`	The HTML page title of the knowledge base.
password_enabled	boolean	No	false	Whether the knowledge base password protection is enabled.
password	string	No		The password for the knowledge base. password_enabled must be true.
primary	boolean	No		Whether the knowledge base is the primary. The primary knowledge base is the one that would remain active in case you downgrade your plan.

Example Request

curl -i -X POST https://api.groovehq.com/v1/kb \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
        "title": "To the moon and back",
        "theme_id": "4517239960",
        "subdomain": "the-moon"
    }'

Example Response

Status: 201 Created

{
    "knowledge_base": {
        "id": "4216430596",
        "created_at": "2019-10-31T08:24:10Z",
        "custom_domain_expires_at": null,
        "custom_domain_letsencrypt": false,
        "custom_domain_status": null,
        "custom_domain_valid": false,
        "custom_scripts_enabled": false,
        "custom_domain": null,
        "enabled": true,
        "ga_anonymized": false,
        "ga_code": null,
        "ip_addresses_enabled": false,
        "ip_addresses": [],
        "language": "en",
        "meta_description": null,
        "meta_robots": "INDEX,FOLLOW",
        "og_description": null,
        "og_image_url": null,
        "og_title": null,
        "page_title": null,
        "password_enabled": false,
        "password": null,
        "primary": false,
        "published_theme_id": "4517239960",
        "ratings_type": "emoji",
        "redirect_legacy": false,
        "site_url": "https://the-moon.groovehq.com/help",
        "subdomain_url": "https://the-moon.groovehq.com/help",
        "subdomain": "the-moon",
        "theme_id": "4517239960",
        "title": "To the moon and back",
        "updated_at": "2019-10-31T08:24:10Z"
    }
}

Listing knowledge bases

GET https://api.groovehq.com/v1/kb

Example Request

curl -i -X GET https://api.groovehq.com/v1/kb \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "knowledge_bases": [
        {
            "id": "5613409027",
            "created_at": "2018-05-28T09:57:57Z",
            "custom_domain_expires_at": null,
            "custom_domain_letsencrypt": true,
            "custom_domain_status": "pending",
            "custom_domain_valid": false,
            "custom_scripts_enabled": true,
            "custom_domain": "groove-supportguy.groove.help",
            "enabled": true,
            "ga_anonymized": false,
            "ga_code": "123456795-50",
            "ip_addresses_enabled": false,
            "ip_addresses": [
                "85.147.61.241-85.147.61.243",
                "83.44.112.0/24",
                "1200:0000:AB00:1234:0000:2552:7777:1313",
                "2620:0:2d0:200::7/32",
                "196.196.150.6"
            ],
            "language": "en",
            "meta_description": null,
            "meta_robots": "NOINDEX,FOLLOW",
            "og_description": null,
            "og_image_url": null,
            "og_title": null,
            "page_title": null,
            "password_enabled": false,
            "password": "groove",
            "primary": true,
            "published_theme_id": "4517239960",
            "ratings_type": "emoji",
            "redirect_legacy": false,
            "site_url": "https://supportguy.groovehq.com/help",
            "subdomain_url": "https://supportguy.groovehq.com/help",
            "subdomain": "supportguy",
            "theme_id": "4517239960",
            "title": "Groove Support Guy",
            "updated_at": "2019-10-29T09:14:10Z"
        },
        {
            "id": "4216430596",
            "created_at": "2019-10-31T08:24:10Z",
            "custom_domain_expires_at": null,
            "custom_domain_letsencrypt": false,
            "custom_domain_status": null,
            "custom_domain_valid": false,
            "custom_scripts_enabled": false,
            "custom_domain": null,
            "enabled": true,
            "ga_anonymized": false,
            "ga_code": null,
            "ip_addresses_enabled": false,
            "ip_addresses": [],
            "language": "en",
            "meta_description": null,
            "meta_robots": "INDEX,FOLLOW",
            "og_description": null,
            "og_image_url": null,
            "og_title": null,
            "page_title": null,
            "password_enabled": false,
            "password": null,
            "primary": false,
            "published_theme_id": "4517239960",
            "ratings_type": "emoji",
            "redirect_legacy": false,
            "site_url": "https://the-moon.groovehq.com/help",
            "subdomain_url": "https://the-moon.groovehq.com/help",
            "subdomain": "the-moon",
            "theme_id": "4517239960",
            "title": "To the moon and back",
            "updated_at": "2019-10-31T08:24:10Z"
        }
    ]
}

Geting a knowledge base

GET https://api.groovehq.com/v1/kb/:id

Example Request

curl -i -X GET https://api.groovehq.com/v1/kb/4216430596 \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "knowledge_base": {
        "id": "4216430596",
        "created_at": "2019-10-31T08:24:10Z",
        "custom_domain_expires_at": null,
        "custom_domain_letsencrypt": false,
        "custom_domain_status": null,
        "custom_domain_valid": false,
        "custom_scripts_enabled": false,
        "custom_domain": null,
        "enabled": true,
        "ga_anonymized": false,
        "ga_code": null,
        "ip_addresses_enabled": false,
        "ip_addresses": [],
        "language": "en",
        "meta_description": null,
        "meta_robots": "INDEX,FOLLOW",
        "og_description": null,
        "og_image_url": null,
        "og_title": null,
        "page_title": null,
        "password_enabled": false,
        "password": null,
        "primary": false,
        "published_theme_id": "4517239960",
        "ratings_type": "emoji",
        "redirect_legacy": false,
        "site_url": "https://the-moon.groovehq.com/help",
        "subdomain_url": "https://the-moon.groovehq.com/help",
        "subdomain": "the-moon",
        "theme_id": "4517239960",
        "title": "To the moon and back",
        "updated_at": "2019-10-31T08:24:10Z"
    }
}

Updating a knowledge base

PUT https://api.groovehq.com/v1/kb/:id

Parameters

Name	Type	Required	Default	Notes
custom_domain_letsencrypt	boolean	No		Whether to use Groove provided certificates with LetsEncrypt. customDomain must be provided.
custom_domain	string	No		Custom domain of the knowledge base.
enabled	boolean	No	true	Whether the knowledge base is enabled.
ga_anonymized	boolean	No	false	Whether to anonymize Google Analytics tracking. ga_code must be provided.
ga_code	string	No		Google Analytics tracking code.
ip_addresses_enabled	boolean	No	false	Whether the knowledge base IP address protection is enabled.
ip_addresses	array	No		The array of IP addresses to protect with. ip_addresses_enabled must be enabled.
language	string	No	en	The RFC 5646 locale code of the knowledge base.
meta_description	string	No		The meta tag description of the knowledge base.
meta_robots	string	No	INDEX,FOLLOW	The meta robots values of the knowledge base.
og_description	string	No		The open graph meta description of the knowledge base.
og_image_url	string	No		The URL to the open graph meta image of the knowledge base.
og_title	string	No	`title`	The open graph title of the knowledge base.
page_title	string	No	`title`	The HTML page title of the knowledge base.
password_enabled	boolean	No	false	Whether the knowledge base password protection is enabled.
password	string	No		The password for the knowledge base. password_enabled must be true.
primary	boolean	No		Whether the knowledge base is primary. Primary knowledge base is the default one linked in the main navigation of the Groove application, as well as the one that would remain active in case you downgrade your plan.
subdomain	string	No		The unique subdomain of the knowledge base.
theme_id	integer	No		The ID of Theme for the knowledge base.
title	string	No		The title of the knowledge base.

Example Request

curl -i -X PUT https://api.groovehq.com/v1/kb/4216430596 \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
        "ga_code": "UA-000000-1",
        "language": "es"
    }'

Example Response

Status: 200 OK

{
    "knowledge_base": {
        "id": "4216430596",
        "created_at": "2019-10-31T08:24:10Z",
        "custom_domain_expires_at": null,
        "custom_domain_letsencrypt": false,
        "custom_domain_status": null,
        "custom_domain_valid": false,
        "custom_scripts_enabled": false,
        "custom_domain": null,
        "enabled": true,
        "ga_anonymized": false,
        "ga_code": "UA-000000-1",
        "ip_addresses_enabled": false,
        "ip_addresses": [],
        "language": "es",
        "meta_description": null,
        "meta_robots": "INDEX,FOLLOW",
        "og_description": null,
        "og_image_url": null,
        "og_title": null,
        "page_title": null,
        "password_enabled": false,
        "password": null,
        "primary": false,
        "published_theme_id": "4517239960",
        "ratings_type": "emoji",
        "redirect_legacy": false,
        "site_url": "https://the-moon.groovehq.com/help",
        "subdomain_url": "https://the-moon.groovehq.com/help",
        "subdomain": "the-moon",
        "theme_id": "4517239960",
        "title": "To the moon and back",
        "updated_at": "2019-10-31T08:33:34Z"
    }
}

Deleting a knowledge base

DELETE https://api.groovehq.com/v1/kb/:id

Example Request

curl -i -X DELETE https://api.groovehq.com/v1/kb/4216430596 \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 204 No Content