Groove

FREE
By groove
Updated 4 months ago
Commerce
5.9/10
Popularity Score
627ms
Latency
85%
Success Rate

Groove API Documentation

Groove is a simple tool for growing small businesses - help your team deliver personal customer support. Ticket management, tracking and reports, and email integration.

View API Details
Tickets
POSTCreate a new ticket
GETList tickets
GETFind one ticket
GETFind one ticket's state
PUTUpdate a ticket state
Messages
GETList all messages
GETFind one message
POSTCreate a new message
Customers
GETList all customers
GETFind one customer
PUTUpdate one customer
Agents
GETFind one agent
POSTCreate a new ticket
Authorization:

All requests to the API must be authenticated with an access token.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
bodySTRING
REQUIREDThe body of the first comment to add to the ticket
fromSTRING
REQUIREDThe email address of the agent or customer who sent the ticket or hash of customer attributes
toSTRING
REQUIREDThe email address of the customer or mailbox that the ticket is addressed to or a hash of customer attributes
access_tokenQUERY
REQUIREDdescription
Optional Parameters
assigned_groupSTRING
OPTIONALThe name of the assigned group
assigneeSTRING
OPTIONALThe email of the agent to assign the ticket to
noteBOOLEAN
OPTIONALWhen creating a ticket from an agent, should the message body be added as a private note
send_copy_to_customerBOOLEAN
OPTIONALWhen creating a ticket from an agent, should the message be emailed to the customer
stateSTRING
OPTIONALThe ticket state. Allowed states are: "unread", "opened", "follow_up", "pending", "closed", "spam"
tagsSTRING
OPTIONALA list of tag names
Code Snippet
unirest.post("https://groove.p.rapidapi.com/tickets")
.header("X-RapidAPI-Host", "groove.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://groove.p.rapidapi.com/tickets
Request Method: POST
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://groove.p.rapidapi.com/tickets")
.header("X-RapidAPI-Host", "groove.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication