https://github.com/pvik/go-whd
A go library to access WebHelpDesk via its Rest API
https://github.com/pvik/go-whd
Last synced: 5 months ago
JSON representation
A go library to access WebHelpDesk via its Rest API
- Host: GitHub
- URL: https://github.com/pvik/go-whd
- Owner: pvik
- License: isc
- Created: 2019-06-16T17:49:51.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T17:26:41.000Z (over 3 years ago)
- Last Synced: 2025-08-14T02:53:22.575Z (10 months ago)
- Language: Go
- Size: 115 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-whd: Solarwinds© Web Help Desk Golang API
DISCLAIMER: I have no affiliation to SolarWinds© and this is a third party API. This is _NOT_ supported by SolarWinds©. Solarwinds and Web Help Desk are [Trademarks of Solarwinds](https://www.solarwinds.com/legal/trademarks).
A golang wrapper around the Web Help Desk REST API. Allows you to interact with the Solarwinds Web Help Desk REST API from your applications seamlessly.
The API is based on the SolarWinds Web Help Desk REST API documentation for 12.7.4 found [here](https://documentation.solarwinds.com/archive/pdf/whd/whdapiguide.pdf).
Supported Features:
* Authenticate (Username/Password;API Key;Session Key)
* Create/Update Tickets
* Support for manipulating Ticket Custom fields
* Add Worklog notes to Tickets
* Retreive Ticket Worklog Notes
* Add Attachments
* Retreive Attachments (From Tickets and Worklog Notes)
* Locations/Status/Ticket Type Objects provided for easy manipulation and access to these fields in Tickets
## Getting Started
### Installing
To start using `go-whd` include the following in you application import:
```
"github.com/pvik/go-whd/whd"
```
### Example
#### Retrieve a ticket
```go
whdTicketID := 1000
var whdTicket whd.Ticket
err := whd.GetTicket(Host,
whd.User{Pass: ApiKey, Type: whd.ApiKeyAuth},
whdTicketID,
&whdTicket)
if err != nil {
log.Errorf("Unable to retrive ticket from WHD: %s", err)
return
}
log.Debugf("Retrieved Ticket from WHD: %+v", whdTicket)
```