A wrapper library for Zendesk using NodeJS
Install the package via npm
$ npm install zendesk-node-apiCreate a new instance of Zendesk, passing in your Zendesk URL, email and API token.
var Zendesk = require('zendesk-node-api');
var zendesk = new Zendesk({
url: YOUR_ZENDESK_URL, // https://example.zendesk.com
email: YOUR_ZENDESK_EMAIL, // [email protected]
token: YOUR_ZENDESK_API_TOKEN // hfkUny3vgHCcV3UfuqMFZWDrLKms4z3W2f6ftjPT
});ticketsticketFieldsusersuserFieldsmacrossearch- Only.list(/* URL params */)method.
I'll be adding more objects, I'm aiming for 100% test coverage so it may take a little time.
Return an array of all items in the object
zendesk.objects.list(
// (Optional) URL params available for each object.
// https://developer.zendesk.com/rest_api/docs/core/
).then(function(result){
console.log(result);
});Return an item from an ID
zendesk.objects.show(OBJECT_ID).then(function(result){
console.log(result);
});Create an item using keys and values from the Zendesk documentation.
zendesk.objects.create({
// keys and values from the zendesk docs
// https://developer.zendesk.com/rest_api/docs/core/
}).then(function(result){
// result == true
})Update an item from and ID using keys and values from the Zendesk documentation.
zendesk.objects.update(OBJECT_ID, {
// keys and values from the zendesk docs
// https://developer.zendesk.com/rest_api/docs/core/
}).then(function(result){
console.log(result);
})Delete an item from ID
zendesk.objects.delete(OBJECT_ID).then(function(result){
// result == true
}); // List all tickets
zendesk.tickets.list().then(function(tickets){
console.log(tickets);
});
// List all tickets and sort by status and order descendent
// https://developer.zendesk.com/rest_api/docs/core/tickets#list-tickets
zendesk.tickets.list('sort_by=status&sort_order=desc').then(function(tickets){
console.log(tickets);
});
// Show a single ticket
zendesk.tickets.show(TICKET_ID).then(function(ticket){
console.log(ticket);
});
// Create a ticket
zendesk.tickets.create({
subject: 'A new ticket',
comment: {
body: 'A ticket created with zendesk-node-api'
}
}).then(function(result){
console.log(result);
});
// Update a ticket
zendesk.tickets.update(TICKET_ID, {
subject: 'An updated subject'
}).then(function(result){
console.log(result);
});
// Delete a ticket
zendesk.tickets.delete(TICKET_ID).then(function(result){
// result == true
});
// List all open tickets
zendesk.search.list('query=type:ticket status:open').then(function(results){
console.log(results);
});- Rename
.env.exampleto.envand add your Zendesk URL, email and API token. - Rename
test/models/config.js.exampleto/test/models/config.js. - Run
npm test, some of the tests will fail, don't worry about it for now. - Update
/test/models/config.jsusing IDs found from CURL. (see example below) - Run
npm test, if your configuration is set correctly, there should be no failing tests.
# Tickets
curl https://{subdomain}.zendesk.com/api/v2/tickets.json -v -u {email_address}:{password}
# Users
curl https://{subdomain}.zendesk.com/api/v2/users.json -v -u {email_address}:{password}
# User fields
curl https://{subdomain}.zendesk.com/api/v2/user_fields.json -v -u {email_address}:{password}
# Macros
curl https://{subdomain}.zendesk.com/api/v2/macros.json -v -u {email_address}:{password}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent