Groove is a customer support platform for small and growing businesses, providing a shared inbox, knowledge base, live chat, and automation tools. It consolidates emails, chats, and social messages into one workspace and offers a customizable self-service knowledge base to reduce support volume. Its API manages support tickets, customers, agents, groups, knowledge base articles, and widgets.
Power end-to-end data operations for your Groove API with Nexla. Our bi-directional Groove connector is purpose-built for Groove, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Groove or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Groove workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
To connect Nexla to Groove, you need an active Groove account with administrator access and a Groove API key. The Groove API uses Bearer token authentication — your API key is passed as a Bearer token in the Authorization header of every request.
Click your account avatar or name in the upper-right corner, and select Settings from the dropdown menu.
In the left navigation panel, scroll to the Developer section and click API.
Click the Generate Token button (or Create New Token if you have existing tokens) to create a new API key.
Copy the generated API token immediately and store it securely. This is your API key value that you will enter in Nexla.
Your API key grants access to your Groove account data. Store it securely and avoid sharing it. Groove tokens expire one year from the date of creation, or when manually revoked. Generate a new token before expiry to avoid interruptions in your Nexla data flows. For complete information about Groove API authentication, visit the Groove API documentation.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your Groove API key in the API Key Value field. This is the Bearer token generated in your Groove account settings (see Generate a Groove API Key above). Nexla will send this value as a Bearer token in the Authorization header of all API requests to Groove.
Important
The API Key Value field is a password-type field — the value will be masked after entry. Ensure you have copied the correct token from your Groove account settings before saving.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Groove connector tile, then select the credential that will be used to connect to the Groove instance, and click Next; or, create a new Groove credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Groove endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.
List Tickets
Retrieves a paginated list of support tickets from your Groove account. Use this endpoint to pull a full or filtered collection of tickets for reporting, analysis, or synchronization with other systems.
This endpoint returns tickets in pages of 25 records. Nexla automatically handles pagination to retrieve all available tickets.
Assignee (optional): Enter the Groove agent ID to filter tickets assigned to a specific agent. Leave blank to retrieve tickets for all agents.
Customer (optional): Enter the Groove customer ID to retrieve only tickets associated with that customer.
State (optional): Enter a ticket state to filter results. Supported values include open, closed, and pending. Leave blank to retrieve tickets in all states.
Folder (optional): Enter a Groove folder ID to return only tickets in that folder. Folders in Groove are used to organize tickets by category or team.
Agent IDs, customer IDs, and folder IDs can be retrieved using the List Agents, List Customers, and other Groove endpoints. For more information about Groove ticket fields, see the Groove Tickets API documentation.
Get Ticket
Retrieves the full details of a single support ticket by its ticket number. Use this endpoint when you need complete information about a specific ticket, including its status, assignee, customer, and conversation history.
Ticket Number (required): Enter the ticket number for the ticket you want to retrieve. Ticket numbers are visible in the Groove inbox and in the ticket URL. For example, for the URL https://app.groovehq.com/tickets/1234, the ticket number is 1234.
This endpoint returns a single ticket record rather than a paginated list. For bulk ticket retrieval, use the List Tickets endpoint instead.
List Ticket Messages
Retrieves all messages (replies and notes) in the conversation thread of a specific ticket. Use this endpoint to extract the full message history for a ticket, which is useful for auditing, analysis, or exporting conversation data.
Ticket Number (required): Enter the ticket number whose messages you want to retrieve. Messages are returned as a paginated list with 25 records per page, and Nexla automatically fetches all pages.
Messages include both customer-facing replies and internal agent notes. For more information about Groove message fields, see the Groove Tickets API documentation.
List Customers
Retrieves a paginated list of all customers in your Groove account. Use this endpoint to export your customer directory for CRM synchronization, analysis, or integration with other business systems.
This endpoint returns all customers with no required configuration. Nexla automatically handles pagination to retrieve all available customer records (25 per page).
Customer records in Groove include contact information, ticket history links, and custom properties. For more details, see the Groove Customers API documentation.
List Agents
Retrieves a list of all support agents in your Groove account. Use this endpoint to synchronize your agent roster with other systems or to obtain agent IDs needed for filtering tickets by assignee.
Group (optional): Enter a Groove agent group ID to return only agents belonging to that group. Leave blank to retrieve all agents across all groups.
The response includes each agent's ID, name, email address, and role. Agent IDs can be used as the Assignee filter in the List Tickets endpoint. For more information, see the Groove Agents API documentation.
List Groups
Retrieves all agent groups defined in your Groove account. Groups in Groove are used to organize agents by team, department, or function, and can be assigned to tickets for team-based routing.
This endpoint returns all groups with no required configuration. No pagination is applied — all groups are returned in a single response.
List Knowledge Bases
Retrieves all knowledge bases configured in your Groove account. Use this endpoint to discover available knowledge bases and their IDs, which are required as input parameters for other knowledge base endpoints such as Get Knowledge Base, Search Articles, and Search Categories.
This endpoint returns all knowledge bases with no required configuration. All records are returned in a single response without pagination.
Get Knowledge Base
Retrieves the details of a specific knowledge base by its ID. Use this endpoint to access knowledge base metadata including its name, configuration, and associated settings.
Knowledge Base ID (required): Enter the ID of the knowledge base to retrieve. Knowledge base IDs can be obtained using the List Knowledge Bases endpoint.
Get Knowledge Base Settings
Retrieves the display and customization settings for a specific knowledge base, including branding, layout, and visibility settings. Use this endpoint to audit or back up knowledge base configuration.
Knowledge Base ID (required): Enter the ID of the knowledge base whose settings you want to retrieve. Knowledge base IDs can be obtained using the List Knowledge Bases endpoint.
Search Categories
Searches for categories within a specific knowledge base. Categories in Groove organize knowledge base articles by topic, making it easier for customers to navigate self-service content. Use this endpoint to retrieve category metadata or to find specific categories by keyword or state.
Knowledge Base ID (required): Enter the ID of the knowledge base in which to search. Knowledge base IDs can be obtained using the List Knowledge Bases endpoint.
Keyword (optional): Enter a search term to filter categories by name or content.
Author ID (optional): Enter an author ID to return only categories created by that author.
Sort Order (optional): Enter a field name to sort results, such as created_at or name.
State (optional): Enter a state value to filter categories. Supported values include published and draft.
Unpaginated (optional): Set to true to return all results in a single response without pagination. By default, results are paginated at 10 per page.
Searches for articles within a specific knowledge base using multiple filter options. Use this endpoint to retrieve published or draft articles, filter by author or category, or find specific articles by tag or ID.
Knowledge Base ID (required): Enter the ID of the knowledge base in which to search for articles.
Keyword (optional): Enter a search term to filter articles by title, body, or content.
Author ID (optional): Enter an author ID to return only articles created by that author.
Category ID (optional): Enter a category ID to return only articles belonging to that category.
Featured (optional): Set to true to return only articles marked as featured in the knowledge base.
IDs (optional): Enter a comma-separated list of article IDs to retrieve specific articles by ID.
Sort Order (optional): Enter a field name to sort results, such as created_at or title.
State (optional): Enter a state value to filter articles. Supported values include published and draft.
Tag (optional): Enter a tag to filter articles associated with that tag.
Unpaginated (optional): Set to true to return all matching articles in a single response without pagination. By default, results are paginated at 10 per page.
Retrieves a specific knowledge base article by its ID. Use this endpoint to access the full content of an individual article, including its title, body, category, tags, and publication status.
Knowledge Base ID (required): Enter the ID of the knowledge base that contains the article. Knowledge base IDs can be obtained using the List Knowledge Bases endpoint.
Article ID (required): Enter the ID of the article to retrieve. Article IDs can be obtained using the Search Articles endpoint.
List Widgets
Retrieves all widgets configured in your Groove account. Groove widgets are embeddable chat or contact forms that appear on your website to enable customer interactions. Use this endpoint to audit your widget configurations or retrieve widget IDs for use with other widget endpoints.
This endpoint returns all widgets with no required configuration. All records are returned in a single response without pagination.
Retrieves the details of a specific widget by its ID. Use this endpoint to access the full configuration of an individual Groove widget, including its type, settings, and display options.
Widget ID (required): Enter the ID of the widget to retrieve. Widget IDs can be obtained using the List Widgets endpoint.
List Widget Settings
Retrieves all configuration settings for a specific Groove widget. Use this endpoint to audit or export the detailed settings of a widget, such as its appearance, behavior, and knowledge base association.
Widget ID (required): Enter the ID of the widget whose settings you want to retrieve. Widget IDs can be obtained using the List Widgets endpoint.
Search Articles (Public)
Searches for publicly accessible articles in a knowledge base using the public Groove API endpoint. This endpoint is intended for retrieving articles as they appear to end customers (i.e., published articles only), making it suitable for integrating public knowledge base content into other customer-facing tools.
Knowledge Base ID (optional): Enter the ID of the knowledge base to search. If not specified, all public knowledge bases are searched.
Keyword (optional): Enter a search keyword to filter articles by title or content.
Category ID (optional): Enter a category ID to limit results to articles in that category.
Featured (optional): Set to true to return only featured articles.
Article IDs (optional): Enter a comma-separated list of article IDs to retrieve specific articles.
Tag (optional): Enter a tag to filter articles associated with that tag.
This endpoint accesses Groove's public API at https://api.groovehq.com/v1/kb/public/{'{kb_id}'}/articles/search and returns only published articles visible to customers. For administrative access to draft and published articles, use the Search Articles endpoint instead.
Get Widget (Public)
Retrieves a specific Groove widget by its UUID using the public API endpoint. Use this endpoint to access public-facing widget configuration details.
Widget UUID (optional): Enter the UUID of the widget to retrieve. Widget UUIDs can be found in your Groove widget settings.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Groove data sources can also be manually configured to ingest data from any valid Groove API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
All Groove API v1 endpoints follow the base URL format https://api.groovehq.com/v1/. For example, to list tickets the full URL would be https://api.groovehq.com/v1/tickets. Many Groove list endpoints return pagination metadata alongside the records array — for example, the List Tickets endpoint returns a JSON object with a top-level tickets array, so the path to data would be $.tickets[*].
You do not need to include the Authorization header manually — it is automatically provided by the Groove credential you selected. The Groove API key is passed as a Bearer token in the Authorization header by Nexla on every request.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Groove data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Click the + icon on the Nexset that will be sent to the Groove destination, and select the Send to Destination option from the menu. Select the Groove connector from the list of available destination connectors, then select the credential that will be used to connect to the Groove organization, and click Next; or, create a new Groove credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Groove endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Create a Ticket
Creates a new support ticket in Groove. Use this endpoint to programmatically open tickets from external systems — for example, to create a Groove ticket whenever a form submission, event, or alert occurs in another platform connected to Nexla.
This endpoint sends the data from your Nexset as the ticket payload in JSON format. Structure your Nexset to include the fields expected by the Groove Tickets API, such as the message body, subject, customer email, and assigned agent or group.
The Groove Tickets API requires the following fields at minimum:
body: The content of the first ticket message.
from: The email address of the customer associated with the ticket.
mailbox: The mailbox (inbox) in which the ticket should be created, specified by mailbox email or ID.
Updates the state of an existing Groove ticket. Use this endpoint to close, reopen, or set a ticket to pending based on data from another system — for example, to automatically close Groove tickets when a corresponding issue is resolved in a project management tool.
Ticket Number (required): Enter the ticket number of the ticket to update. This value is appended to the Groove API URL path. Ticket numbers are visible in the Groove inbox and in the ticket URL.
The request payload should contain the new state for the ticket. Supported state values are:
open: Marks the ticket as open and active.
closed: Closes the ticket and removes it from the active inbox.
pending: Marks the ticket as pending a customer response.
Assigns or reassigns a ticket to a specific Groove agent. Use this endpoint to route tickets to the appropriate agent based on data from another system — for example, to automatically assign tickets based on customer tier, topic, or region.
Ticket Number (required): Enter the ticket number of the ticket to update. Ticket numbers are visible in the Groove inbox and in the ticket URL.
The request payload should contain the agent ID of the agent to assign. Agent IDs can be obtained using the List Agents data source endpoint.
Update Ticket Assigned Group
Assigns or reassigns a ticket to an agent group in Groove. Use this endpoint to route tickets to an entire team rather than a specific individual, which is useful for load balancing or skills-based routing scenarios.
Ticket Number (required): Enter the ticket number of the ticket to update.
The request payload should contain the group ID of the agent group to assign. Group IDs can be obtained using the List Groups data source endpoint.
Create Message
Adds a new message to an existing Groove ticket conversation. Use this endpoint to programmatically append replies or internal notes to tickets — for example, to post automated status updates, notifications, or responses from external systems into Groove ticket threads.
Ticket Number (required): Enter the ticket number to which the message will be added. This value is used in the API URL path.
The request payload should contain the message content. Key fields include:
body: The text content of the message.
note: Set to true to create an internal agent note rather than a customer-facing reply.
Creates a new webhook in Groove to receive event notifications. Use this endpoint to programmatically register webhook endpoints that will receive Groove event notifications such as new tickets, ticket state changes, or new messages.
This endpoint sends the webhook configuration payload from your Nexset to the Groove Webhooks API. The payload should include the webhook URL and the event types to subscribe to.
The Groove Webhooks API payload should include:
webhook_url: The URL that Groove will send event notifications to.
event_types: An array of event types to subscribe to (e.g., ticket.created, ticket.state_changed).
For a complete list of supported Groove webhook event types and payload structure, see the Groove API documentation.
Create Group
Creates a new agent group in Groove. Use this endpoint to programmatically create groups for organizing agents by team, department, or function. Groups can be assigned to tickets to enable team-based routing.
This endpoint sends the group configuration from your Nexset as a JSON payload to the Groove Groups API. The payload should include the group name and, optionally, the agent IDs to add as initial members.
Update Group
Updates an existing Groove agent group's name, description, or member list. Use this endpoint to synchronize agent group memberships from an external HR or directory system into Groove.
Group ID (required): Enter the ID of the group to update. Group IDs can be obtained using the List Groups data source endpoint.
The request payload should contain the group properties to update, such as the group name or the list of agent IDs to include as members.
Create Knowledge Base
Creates a new knowledge base in your Groove account. Use this endpoint to programmatically provision knowledge bases for customer self-service support as part of an automated setup workflow.
This endpoint sends the knowledge base configuration from your Nexset as a JSON payload. The payload should include the knowledge base name and any initial configuration settings.
Updates the configuration and settings of an existing Groove knowledge base. Use this endpoint to synchronize knowledge base metadata or settings from an external content management system.
Knowledge Base ID (required): Enter the ID of the knowledge base to update. Knowledge base IDs can be obtained using the List Knowledge Bases data source endpoint.
The request payload should contain the knowledge base properties to update, such as the name or default language.
Update Knowledge Base Settings
Updates the display and customization settings for a specific Groove knowledge base, including branding, layout, and visibility options. Use this endpoint to apply bulk configuration changes to knowledge base presentation settings.
Knowledge Base ID (required): Enter the ID of the knowledge base whose settings you want to update. Knowledge base IDs can be obtained using the List Knowledge Bases data source endpoint.
The request payload should contain the settings properties to update. Refer to the Groove API documentation for the complete list of configurable settings fields.
Create Article
Creates a new article within a specific Groove knowledge base. Use this endpoint to programmatically publish help content — for example, to automatically create Groove knowledge base articles from an external content management system or documentation repository.
Knowledge Base ID (required): Enter the ID of the knowledge base in which to create the article. Knowledge base IDs can be obtained using the List Knowledge Bases data source endpoint.
The request payload should contain the article content. Key fields include:
title: The article title.
body: The article body content in HTML format.
state: The publication state, either published or draft.
category_id: The ID of the category to associate the article with (optional).
Updates an existing article in a Groove knowledge base. Use this endpoint to keep Groove knowledge base content in sync with an external documentation source by pushing article updates programmatically.
Knowledge Base ID (required): Enter the ID of the knowledge base that contains the article to update.
Article ID (required): Enter the ID of the article to update. Article IDs can be obtained using the Search Articles data source endpoint.
The request payload should contain the article properties to update, such as the title, body, state, or category.
Updates the configuration of an existing Groove widget. Use this endpoint to programmatically apply configuration changes to Groove chat or contact widgets embedded on your website.
Widget ID (required): Enter the ID of the widget to update. Widget IDs can be obtained using the List Widgets data source endpoint.
The request payload should contain the widget properties to update. Refer to the Groove Widgets API documentation for the complete list of configurable widget fields.
Update Widget Settings
Updates the configuration settings for a specific Groove widget, including appearance, behavior, and knowledge base associations. Use this endpoint to apply bulk configuration changes to widget settings from an external system.
Widget ID (required): Enter the ID of the widget whose settings you want to update. Widget IDs can be obtained using the List Widgets data source endpoint.
The request payload should contain the settings properties to update. Refer to the Groove Widgets API documentation for supported settings fields.
Groove destinations can also be manually configured to send data to any valid Groove API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
The Groove API accepts data in JSON format; Nexla will automatically convert Nexset data to JSON for each API call. All Groove API v1 endpoints use the base URL https://api.groovehq.com/v1/. For update operations that require a resource identifier, include the ID at the end of the URL path — for example, https://api.groovehq.com/v1/tickets/1234/state to update the state of ticket number 1234. Using manual configuration, you can also configure Nexla to automatically send the response received from the Groove API after each call to a new Nexla webhook data source.
You do not need to include the Authorization header manually — it is automatically handled by the Groove credential. The API key is sent as a Bearer token in the Authorization header by Nexla on every request.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Groove endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Groove until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
