API
Login Sign Up

Widgets

Creating a new widget

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

Parameters

Name Type Required Default Notes
name string Yes The name of the widget.

Example Request

curl -i -X POST https://api.groovehq.com/v1/widgets \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{ "name": "Groove Support"}'

Example Response

Status: 201 Created

{
    "widget": {
        "id": "9452013386",
        "created_at": "2020-03-25T12:25:35Z",
        "name": "Groove Support",
        "published_settings": {},
        "updated_at": "2020-03-25T12:25:35Z",
        "uuid": "9fca55b3-e012-422b-aed3-9cc717e44965"
    }
}

Listing widgets

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

Example Request

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

Example Response

Status: 200 OK

{
    "widgets": [
        {
            "id": "9452013386",
            "created_at": "2020-03-25T12:25:35Z",
            "name": "Groove Support",
            "published_settings": {
                "branding_disabled": false,
                "contact.name_field_enabled": true,
                "contact.subject_field_enabled": true,
                "enabled": true,
                "icon_display": "icon",
                "icon_position": "right",
                "icon_style": "outline",
                "icon_text": "Need a hand?",
                "icon": "chat",
                "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": "9999"
            },
            "updated_at": "2020-03-25T12:25:35Z",
            "uuid": "9fca55b3-e012-422b-aed3-9cc717e44965"
        }
    ]
}

Geting a widget

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

Example Request

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

Example Response

Status: 200 OK

{
    "widget": {
        "id": "9452013386",
        "created_at": "2020-03-25T12:25:35Z",
        "name": "Groove Support",
        "published_settings": {
            "branding_disabled": false,
            "contact.name_field_enabled": true,
            "contact.subject_field_enabled": true,
            "enabled": true,
            "icon_display": "icon",
            "icon_position": "right",
            "icon_style": "outline",
            "icon_text": "Need a hand?",
            "icon": "chat",
            "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": "9999"
        },
        "updated_at": "2020-03-25T12:25:35Z",
        "uuid": "9fca55b3-e012-422b-aed3-9cc717e44965"
    }
}

Updating a widget

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

Parameters

Name Type Required Default Notes
name string Yes The name of the widget.
enabled boolean No true Whether the widget is enabled.

Example Request

curl -i -X PUT https://api.groovehq.com/v1/widgets/9452013386 \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{ "name": "Upcoming beta" }'

Example Response

Status: 200 OK

{
    "widget": {
        "id": "9452013386",
        "created_at": "2020-03-25T12:25:35Z",
        "name": "Upcoming beta",
        "published_settings": {
            "branding_disabled": false,
            "contact.name_field_enabled": true,
            "contact.subject_field_enabled": true,
            "enabled": true,
            "icon_display": "icon",
            "icon_position": "right",
            "icon_style": "outline",
            "icon_text": "Need a hand?",
            "icon": "chat",
            "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": "9999"
        },
        "updated_at": "2020-03-25T12:29:57Z",
        "uuid": "9fca55b3-e012-422b-aed3-9cc717e44965"
    }
}

Deleting a widget

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

Example Request

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

Example Response

Status: 204 No Content