-
-
Notifications
You must be signed in to change notification settings - Fork 801
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from fimtitzgerald/param_uname
Added static documentation for Zendesk module
- Loading branch information
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: "Zendesk" | ||
date: 2018-07-23T18:55:37-08:00 | ||
draft: false | ||
--- | ||
|
||
Displays tickets in the "New" status - i.e. have not yet been assigned. | ||
|
||
## Source Code | ||
|
||
```bash | ||
wtf/zendesk/ | ||
``` | ||
|
||
## Required ENV Variables | ||
|
||
<span class="caption">Key:</span> `ZENDESK_API` <br /> | ||
<span class="caption">Value:</span> Your Zendesk API Token | ||
|
||
<span class="caption">Key:</span> `ZENDESK_DOMAIN` <br /> | ||
<span class="caption">Value:</span> Your Zendesk subdomain | ||
|
||
## Configuration | ||
|
||
```yaml | ||
zendesk: | ||
enabled: true | ||
username: "your_email@acme.com" | ||
position: | ||
top: 0 | ||
left: 2 | ||
height: 1 | ||
width: 1 | ||
``` | ||
### Attributes | ||
`username` <br /> | ||
Your Zendesk username | ||
Values: A valid Zendesk username (usually an email address). |