Skip to docs navigation

SherpaDesk integration guide

Verified

How to connect SherpaDesk to WEXTL and use its 2 triggers and 27 actions in your workflows. About SherpaDesk: IT help desk and service management: tickets, tasks, assets, accounts, invoices, time entries and knowledge.

  • 2 triggers
  • 17 searches
  • 10 actions
  • Polling
  • Auth: API key

AI-assisted documentation7 min read

This documentation is compiled from our integration source code, internal specs for SherpaDesk, its official API documentation and anonymized requests logs we collect from our support team[2].

Open SherpaDesk on WEXTL →
  • SherpaDesk
  • WEXTL
  • Gorgias
  • Deskpro
  • Atomicwork
  • Enchant
  • eDesk
  • BoldDesk
  • Cliniko
  • AlfaDocs
  • Capacity
  • Classe365
  • Chatling
  • Denser AI
  • Exercise
  • Frill
  • Charla
  • CommBox
  • Chatwoot
  • Freshdesk
  • Freshservice
  • Gladly
  • EasyPractice
  • Gleap
  • Dentally
  • Front
  • Gist
  • Clio Grow
  • CharmHealth
  • DaySmart Vet
  • CareCloud
  • Clio Manage
  • Organization-Instance KeytextRequired

    Your organization and instance key joined with a hyphen, e.g. ncg1in-8d1rag. Used as the Basic Auth username.[1]

  • API TokenpasswordRequired

    Your API token, used as the Basic Auth password. Obtain it via GET /login or from your profile.[1]

  1. Log in to your WEXTL account, add the SherpaDesk node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your SherpaDesk account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Accounts

TriggerFires for each account added since the last poll.
Output fields[3]
FieldType
IDnumber
Nametext
Notetext
Is Activeboolean
Is Organizationboolean
BWD Numbertext
Client Contract IDnumber
Numbertext
Ref 1text
Ref 2text
Representative Nametext
Citytext
Statetext
Zipcodetext
Countrytext
Phone 1text
Phone 2text
Address 1text
Address 2text
Email Suffixtext

13other output fields

Watch Projects

TriggerTriggers when a new project shows up.
Output fields[3]
FieldType
IDnumber
Account IDnumber
Account Nametext
Nametext
Full Nametext
Open Ticketsnumber
Closed Ticketsnumber
Prioritynumber
Priority Nametext
Priority Descriptiontext
Logged Hoursnumber
Remaining Hoursnumber
Completenumber
Client Managertext
Internal Project Managertext
Client Project Managertext
Default Contract IDnumber
Estimated Hoursnumber
Project Hoursnumber
Ticket Hoursnumber

4other output fields

Get a Location

ActionOne location as it is stored in SherpaDesk.
Input fields[3]
FieldType
Location IDRequired
choice

Get a Profile

ActionCurrent user profile record.

No fields documented.

Get a Ticket

ActionOne ticket from your help desk.
Input fields[3]
FieldType
Ticket IDRequired
text

Get an Invoice

ActionA single SherpaDesk invoice, with an optional action to run.
Input fields[3]
FieldType
Invoice IDRequired
number
Actiontext

Get Ticket Counts

ActionTicket totals for open, held and waiting states.
Output fields[3]
FieldType
New Messagesnumber
Open Allnumber
Open As Usernumber
Open As Technumber
Open As Alt Technumber
On Holdnumber
Remindernumber
Parts On Ordernumber
Unconfirmednumber
Waitingnumber

Get Tickets by Keys

ActionBatch lookup of tickets from a list of keys.
Input fields[3]
FieldType
KeysRequired
text

List Accounts

SearchAccounts with contacts, locations and statistics.
Input fields[3]
FieldType
Is With Statisticsboolean
Is Open Ticketsboolean
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Notetext
Is Activeboolean
Is Organizationboolean
BWD Numbertext
Client Contract IDnumber
Numbertext
Ref 1text
Ref 2text
Representative Nametext
Citytext
Statetext
Zipcodetext
Countrytext
Phone 1text
Phone 2text
Address 1text
Address 2text
Email Suffixtext

13other output fields

List Assets

SearchAssets kept in SherpaDesk.
Input fields[3]
FieldType
Limitnumber

List Invoices

SearchInvoices stored in SherpaDesk.
Input fields[3]
FieldType
Limitnumber

List Locations

SearchLocations defined for your account.
Input fields[3]
FieldType
Limitnumber

List Organizations

SearchNames, keys and instances of each organization.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Keytext
Nametext
Instancesarray
Keytext
Nametext

List Projects

SearchProjects with ticket counts and hours.
Input fields[3]
FieldType
Accountnumber
Is With Statisticsboolean
Limitnumber
Output fields[3]
FieldType
IDnumber
Account IDnumber
Account Nametext
Nametext
Full Nametext
Open Ticketsnumber
Closed Ticketsnumber
Prioritynumber
Priority Nametext
Priority Descriptiontext
Logged Hoursnumber
Remaining Hoursnumber
Completenumber
Client Managertext
Internal Project Managertext
Client Project Managertext
Default Contract IDnumber
Estimated Hoursnumber
Project Hoursnumber
Ticket Hoursnumber

4other output fields

List Queues

SearchTicket queues defined in SherpaDesk.
Input fields[3]
FieldType
Sort Bytext
Limitnumber

List Task Types

SearchTask types for time entries, by account or project.
Input fields[3]
FieldType
Accountnumber
Projectnumber
Limitnumber

List Tickets

SearchTickets matching a status, account and role.
Input fields[3]
FieldType
Statustext
Accountnumber
Rolechoice
Querytext
Limitnumber

List Time Entries

SearchLogged work, by technician, account or project.
Input fields[3]
FieldType
Typetext
Technumber
Accountnumber
Projectnumber
Limitnumber

List Todos

SearchTodos filtered by completion state.
Input fields[3]
FieldType
All Item Typesboolean
Is Completedboolean
Is Sub Viewboolean
Limitnumber

Add a Ticket Response

ActionReply text added to a ticket.
Input fields[3]
FieldType
Ticket IDRequired
text
ActionRequired
text
Note TextRequired
text

Create a Ticket

ActionOpens a support ticket with its first post.
Input fields[3]
FieldType
SubjectRequired
text
Initial PostRequired
text
Account IDRequired
number
Statustext
Class IDnumber
Location IDnumber
Tech IDnumber
User IDnumber

Create a Time Entry

ActionRecords time worked on a ticket or project.
Input fields[3]
FieldType
HoursRequired
number
Note Texttext
Account IDnumber
Project IDnumber
Ticket Keytext
Task Type IDchoice
Tech IDnumber
Is Project Logboolean
No Invoiceboolean

Create a Todo

ActionNew todo with an optional assignee and due date.
Input fields[3]
FieldType
TitleRequired
text
Texttext
Assigned IDnumber
Due Datedate
Estimated Remainnumber
Notifyboolean
Project IDnumber

Create an Asset

ActionRegisters an asset with its classification and location.
Input fields[3]
FieldType
NameRequired
text
Category IDnumber
Type IDnumber
Make IDnumber
Model IDnumber
Checkout IDnumber
Status IDnumber
Location IDchoice
Entered Datedate
Notetext

Make an API Call

universalCustom SherpaDesk REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Update a Profile

ActionEdits the Skype handle of a user.
Input fields[3]
FieldType
Profile IDRequired
number
Skypetext

Update a Time Entry

ActionEdits logged hours on a time entry.
Input fields[3]
FieldType
Time IDRequired
text
Hoursnumber
Note Texttext
Account IDnumber
Task Type IDchoice
Tech IDnumber
Is Project Logboolean

Update a Todo

ActionSets the completion state of a todo.
Input fields[3]
FieldType
Todo IDRequired
text
Is CompletedRequired
boolean

Upload a File

ActionStores a file and optionally attaches it.
Input fields[3]
FieldType
FileRequired
text
File Nametext
Tickettext
Assetnumber

Look for SherpaDesk templates in the WEXTL template library.

Browse templates →
  1. WEXTL® SherpaDesk Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for SherpaDesk.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 12, 2026 04:29

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.