Widget Public API

Note: The API endpoints below are public and do not require authentication.

Getting a widget

GET https://api.groovehq.com/v1/public/widget/:widget_uuid

Example Request

curl -i -X GET https://api.groovehq.com/v1/public/widgets/b02220f3-a197-4b4e-a9e2-da87cc04ed78 \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "widget": {
        "id": "4517239968",
        "account_id": "5613409065",
        "company": "Groove",
        "created_at": "2020-03-10T08:51:35Z",
        "enabled": true,
        "name": "Groove Support",
        "published_settings": {
            "branding_disabled": false,
            "contact.name_field_enabled": true,
            "contact.subject_field_enabled": true,
            "enabled": true,
            "icon_display": "both",
            "icon_position": "right",
            "icon_style": "outline",
            "icon_text": "Help ?",
            "icon": "chats",
            "kb.featured_enabled": true,
            "kb.ratings_count_enabled": true,
            "kb.ratings_enabled": true,
            "kb.ratings_negative_action_enabled": true,
            "kb.ratings_negative_action_kb_enabled": true,
            "kb.ratings_negative_action_contact_enabled": true,
            "widget_style": "user",
            "z_index": "100",
            "contact.enabled": true,
            "contact.id": "2066990139",
            "kb.enabled": true,
            "kb.id": "0486513218",
            "primary_color": "#1e2825",
            "primary_color_rgb": "30, 40, 37",
            "logo_image_url": "",
            "contact.attachments_enabled": true,
            "contact.consent_enabled": true,
            "contact.consent_optin_enabled": true,
            "contact.consent_optin_selected": true,
            "kb.url": "https://test-kb.groove.help/help"
        },
        "updated_at": "2020-03-20T13:40:26Z",
        "uuid": "b02220f3-a197-4b4e-a9e2-da87cc04ed78"
    }
}